Changeset 1548

Timestamp:

01/23/07 09:49:45 (2 years ago)

Author:

david

Message:

fire eagle number awesome: new layouting system. look at the sample app to get to know it a bit. of course, you don't have to use preconfigured layouts, and of course you can alter a loaded layout at runtime, e.g. prepend another layer, move stuff around, etc etc. now also fully stream-based templating, so you can load template from ftp, http, memory, whatever you like, as long as you have a stream wrapper for it (which you can write yourself) - or you just implement your own layer class that loads templates from database and caches to disk etc. filter and context support will follow in 1.0. renderers are per layer now, too, and more stuff I can't remember. refs #287

Location:

branches/david-execution_flow

Files:

• samples/app/config/output_types.xml (modified) (3 diffs)
• samples/app/modules/Default/views/Error404SuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/IndexSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/LoginInputView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/LoginSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/LogoutSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/ModuleDisabledSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/SearchEngineSpamSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/Secure1SuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/Secure2SuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/SecureSuccessView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/UnavailableSuccessView.class.php (modified) (1 diff)
• src/buildtools/code_templates/View.class.php.tmpl (modified) (1 diff)
• src/buildtools/code_templates/config/output_types.xml (modified) (1 diff)
• src/config/AgaviOutputTypeConfigHandler.class.php (modified) (2 diffs)
• src/config/defaults/autoload.xml (modified) (1 diff)
• src/config/xsd/output_types.xsd (modified) (2 diffs)
• src/controller/AgaviOutputType.class.php (modified) (4 diffs)
• src/filter/AgaviExecutionFilter.class.php (modified) (2 diffs)
• src/renderer/AgaviPhpRenderer.class.php (modified) (3 diffs)
• src/renderer/AgaviPhptalRenderer.class.php (modified) (1 diff)
• src/renderer/AgaviRenderer.class.php (modified) (4 diffs)
• src/renderer/AgaviSmartyRenderer.class.php (modified) (1 diff)
• src/renderer/AgaviXslRenderer.class.php (modified) (1 diff)
• src/util/AgaviToolkit.class.php (modified) (1 diff)
• src/view/AgaviFileTemplateLayer.class.php (added)
• src/view/AgaviStreamTemplateLayer.class.php (added)
• src/view/AgaviTemplateLayer.class.php (modified) (4 diffs)
• src/view/AgaviView.class.php (modified) (2 diffs)

branches/david-execution_flow/samples/app/config/output_types.xml

@@ -12 +12 @@
 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+
 -->
-<configurations>
+<configurations xmlns:xi="http://www.w3.org/2001/XInclude">
   
   <configuration context="web">
@@ -38 +38 @@
           </renderer>
         </renderers>
+        <layouts default="default"> 
+          <layout name="default"> 
+            <layers> 
+              <layer name="content" class="AgaviFileTemplateLayer" /> 
+              <layer name="decorator" class="AgaviFileTemplateLayer"> 
+                <parameters> 
+                  <parameter name="template">Master</parameter> 
+                </parameters> 
+              </layer> 
+            </layers> 
+          </layout> 
+        </layouts> 
         <parameters>
           <parameter name="Content-Type">text/html; charset=UTF-8</parameter>
@@ -44 +56 @@
       
       <output_type name="xhtml">
-        <renderers default="php">
-          <renderer name="php" class="AgaviPhpRenderer">
-            <parameters>
-              <parameter name="assigns">
-                <parameters>
-                  <parameter name="routing">r</parameter>
-                  <parameter name="request">req</parameter>
-                  <parameter name="controller">ctl</parameter>
-                  <parameter name="user">usr</parameter>
-                  <parameter name="translation_manager">tm</parameter>
-                </parameters>
-              </parameter>
-            </parameters>
-          </renderer>
-        </renderers>
+        <xi:include href="#xpointer(//configurations/configuration[@context='web']/output_types/output_type[@name='html']/renderers)" />
+        <xi:include href="#xpointer(//configurations/configuration[@context='web']/output_types/output_type[@name='html']/layouts)" />
         <parameters>
           <parameter name="Content-Type">application/xhtml+xml; charset=UTF-8</parameter>

branches/david-execution_flow/samples/app/modules/Default/views/Error404SuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Error404Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
 
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/IndexSuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'IndexSuccess');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/LoginInputView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'LoginInput');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/LoginSuccessView.class.php

@@ -56 +56 @@
     }
     
-    // set our template
-    $this->addLayer('content', 'LoginInput');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/LogoutSuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'LogoutSuccess');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/ModuleDisabledSuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Error404Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
 
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/SearchEngineSpamSuccessView.class.php

@@ -10 +10 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'SearchEngineSpamSuccess');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/Secure1SuccessView.class.php

@@ -10 +10 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Secure1Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/Secure2SuccessView.class.php

@@ -10 +10 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Secure2Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
     
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/SecureSuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Error404Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
 
     // set the content type

branches/david-execution_flow/samples/app/modules/Default/views/UnavailableSuccessView.class.php

@@ -26 +26 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->addLayer('content', 'Error404Success');
-    $this->addLayer('decorator', 'Master');
+    $this->loadLayout();
 
     // set the content type

branches/david-execution_flow/src/buildtools/code_templates/View.class.php.tmpl

@@ -9 +9 @@
   public function execute(AgaviParameterHolder $parameters)
   {
-    // set our template
-    $this->setTemplate('%%ACTION_PATH%%%%VIEW%%');
-
     // set the title
     $this->setAttribute('_title', '%%ACTION%% Action');

branches/david-execution_flow/src/buildtools/code_templates/config/output_types.xml

@@ -48 +48 @@
 
       <output_type name="html">
-        <renderer class="AgaviPhpRenderer">
-          <parameters>
-            <parameter name="assigns">
-              <parameters>
-                <parameter name="routing">ro</parameter>
-                <parameter name="request">rq</parameter>
-                <parameter name="controller">ct</parameter>
-                <parameter name="user">us</parameter>
-                <parameter name="translation_manager">tm</parameter>
-              </parameters>
-            </parameter>
-          </parameters>
-        </renderer>
+        <renderers default="php">
+          <renderer name="php" class="AgaviPhpRenderer">
+            <parameters>
+              <parameter name="assigns">
+                <parameters>
+                  <parameter name="routing">ro</parameter>
+                  <parameter name="request">rq</parameter>
+                  <parameter name="controller">ct</parameter>
+                  <parameter name="user">us</parameter>
+                  <parameter name="translation_manager">tm</parameter>
+                </parameters>
+              </parameter>
+            </parameters>
+          </renderer>
+        </renderers>
+        <layouts default="default"> 
+          <layout name="default"> 
+            <layers>
+              <layer name="content" class="AgaviFileTemplateLayer" /> 
+            </layers> 
+          </layout> 
+        </layouts> 
         <parameters>
-          <parameter name="Content-Type">text/html</parameter>
+          <parameter name="Content-Type">text/html; charset=UTF-8</parameter>
         </parameters>
       </output_type>

branches/david-execution_flow/src/config/AgaviOutputTypeConfigHandler.class.php

@@ -75 +75 @@
       foreach($cfg->output_types as $outputType) {
         $outputTypeName = $outputType->getAttribute('name');
-        $data[$outputTypeName] = isset($data[$outputTypeName]) ? $data[$outputTypeName] : array('parameters' => array(), 'default_renderer' => null, 'renderers' => array(), 'exception_template' => null);
+        $data[$outputTypeName] = isset($data[$outputTypeName]) ? $data[$outputTypeName] : array('parameters' => array(), 'default_renderer' => null, 'renderers' => array(), 'layouts' => array(), 'default_layout' => null, 'exception_template' => null);
         if(isset($outputType->renderers)) {
           foreach($outputType->renderers as $renderer) {
             $rendererName = $renderer->getAttribute('name');
-            $data[$outputTypeName]['renderers'][$rendererName] = array('instance' => null, 'class' => null, 'extension' => null, 'parameters' => array());
+            $data[$outputTypeName]['renderers'][$rendererName] = array('instance' => null, 'class' => null, 'parameters' => array());
             $data[$outputTypeName]['renderers'][$rendererName]['class'] = $renderer->getAttribute('class');
-            $data[$outputTypeName]['renderers'][$rendererName]['extension'] = $renderer->getAttribute('extension');
             $data[$outputTypeName]['renderers'][$rendererName]['parameters'] = $this->getItemParameters($renderer, $data[$outputTypeName]['renderers'][$rendererName]['parameters']);
           }
           $data[$outputTypeName]['default_renderer'] = $outputType->renderers->getAttribute('default');
+        }
+        if(isset($outputType->layouts)) {
+          foreach($outputType->layouts as $layout) {
+            $layoutName = $layout->getAttribute('name');
+            $data[$outputTypeName]['layouts'][$layoutName] = array('layers' => array());
+            if(isset($layout->layers)) {
+              foreach($layout->layers as $layer) {
+                $layerName = $layer->getAttribute('name');
+                $data[$outputTypeName]['layouts'][$layoutName]['layers'][$layerName] = array('class' => null, 'renderer' => null, 'parameters' => array());
+                $data[$outputTypeName]['layouts'][$layoutName]['layers'][$layerName]['class'] = $layer->getAttribute('class');
+                if(($rendererName = $layer->getAttribute('renderer')) !== null) {
+                  if(!isset($rendererName, $data[$outputTypeName]['renderers'])) {
+                    throw new AgaviConfigurationException('Layout "' . $layoutName . '" specifies layer "' . $layerName . '" with non-defined renderer "' . $rendererName . '".');
+                  }
+                  $data[$outputTypeName]['layouts'][$layoutName]['layers'][$layerName]['renderer'] = $rendererName;
+                }
+                $data[$outputTypeName]['layouts'][$layoutName]['layers'][$layerName]['parameters'] = $this->getItemParameters($layer, $data[$outputTypeName]['layouts'][$layoutName]['layers'][$layerName]['parameters']);
+              }
+            }
+          }
+          $data[$outputTypeName]['default_layout'] = $outputType->layouts->getAttribute('default');
         }
         if($outputType->hasAttribute('exception_template')) {
@@ -101 +121 @@
       $code[] = implode("\n", array(
         '$ot = new AgaviOutputType();',
-        '$ot->initialize($this->context, ' . var_export($outputType['parameters'], true) . ', ' . var_export($outputTypeName, true) . ', ' . var_export($outputType['renderers'], true) . ', ' . var_export($outputType['default_renderer'], true) . ', ' . var_export($outputType['exception_template'], true) . ');',
+        '$ot->initialize($this->context, ' . var_export($outputType['parameters'], true) . ', ' . var_export($outputTypeName, true) . ', ' . var_export($outputType['renderers'], true) . ', ' . var_export($outputType['default_renderer'], true) . ', ' . var_export($outputType['layouts'], true) . ', ' . var_export($outputType['default_layout'], true) . ', ' . var_export($outputType['exception_template'], true) . ');',
         '$this->outputTypes["' . $outputTypeName . '"] = $ot;',
       ));

branches/david-execution_flow/src/config/defaults/autoload.xml

@@ -203 +203 @@
       <autoload name="AgaviSetValidator">%core.agavi_dir%/validator/AgaviSetValidator.class.php</autoload>
       <autoload name="AgaviStringValidator">%core.agavi_dir%/validator/AgaviStringValidator.class.php</autoload>
+      
+      <!-- agavi/view -->
+      <autoload name="AgaviFileTemplateLayer">%core.agavi_dir%/view/AgaviFileTemplateLayer.class.php</autoload>
+      <autoload name="AgaviStreamTemplateLayer">%core.agavi_dir%/view/AgaviStreamTemplateLayer.class.php</autoload>
     </autoloads>
   </configuration>

branches/david-execution_flow/src/config/xsd/output_types.xsd

@@ -30 +30 @@
       <xs:group ref="parameters" />
       <xs:element name="renderers" type="renderers" minOccurs="0" />
+      <xs:element name="layouts" type="layouts" minOccurs="0" />
     </xs:sequence>
     <xs:attribute name="name" type="php_label" use="required" />
@@ -47 +48 @@
     <xs:attribute name="name" type="php_label" use="required" />
     <xs:attribute name="class" type="php_label" use="required" />
-    <xs:attribute name="extension" type="xs:string" />
+  </xs:complexType>
+
+  <xs:complexType name="layouts">
+    <xs:sequence>
+      <xs:element name="layout" type="layout" maxOccurs="unbounded" />
+    </xs:sequence>
+    <xs:attribute name="default" type="php_label" use="required" />
+  </xs:complexType>
+  <xs:complexType name="layout">
+    <xs:sequence>
+      <xs:element name="layers" type="layers" minOccurs="0" />
+    </xs:sequence>
+    <xs:attribute name="name" type="php_label" use="required" />
+  </xs:complexType>
+
+  <xs:complexType name="layers">
+    <xs:sequence>
+      <xs:element name="layer" type="layer" maxOccurs="unbounded" />
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="layer">
+    <xs:sequence>
+      <xs:group ref="parameters" />
+    </xs:sequence>
+    <xs:attribute name="name" type="php_label" use="required" />
+    <xs:attribute name="class" type="php_label" use="required" />
+    <xs:attribute name="renderer" type="php_label" />
   </xs:complexType>
 

branches/david-execution_flow/src/controller/AgaviOutputType.class.php

@@ -49 +49 @@
   
   /**
+   * @var        array An array of configured layouts.
+   */
+  protected $layouts = array();
+  
+  /**
+   * @var        string The name of the default layout, if set.
+   */
+  protected $defaultLayout = null;
+  
+  /**
    * @var        string The name of the exception template for this output type.
    */
@@ -62 +72 @@
    * @since      0.11.0
    */
-  public function initialize(AgaviContext $context, array $parameters, $name, array $renderers, $defaultRenderer, $exceptionTemplate = null)
+  public function initialize(AgaviContext $context, array $parameters, $name, array $renderers, $defaultRenderer, array $layouts, $defaultLayout, $exceptionTemplate = null)
   {
     $this->context = $context;
@@ -73 +83 @@
     
     $this->defaultRenderer = $defaultRenderer;
+    
+    $this->layouts = $layouts;
+    
+    $this->defaultLayout = $defaultLayout;
     
     $this->exceptionTemplate = $exceptionTemplate;
@@ -151 +165 @@
   
   /**
+   * Get a layout.
+   *
+   * @param      The optional name of the layout to fetch.
+   *
+   * @return     array An array of layout information.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getLayout($name = null)
+  {
+    if($name === null) {
+      $name = $this->defaultLayout;
+    }
+    
+    if(isset($this->layouts[$name])) {
+      return $this->layouts[$name];
+    } else {
+      throw new AgaviException('Unknown layout "' . $name . '"');
+    }
+  }
+  
+  /**
    * Get the exception template filename for this renderer.
    *

branches/david-execution_flow/src/filter/AgaviExecutionFilter.class.php

@@ -371 +371 @@
           $output = array();
           $nextOutput = null;
-          foreach($viewInstance->getLayers() as $layerName => $layer) {
+          foreach($viewInstance->getLayers() as $layer) {
             foreach($layer->getSlots() as $slotName => $slotContainer) {
               $slotResponse = $slotContainer->execute();
@@ -383 +383 @@
             $nextOutput = $layer->getRenderer()->render($layer, $attributes, $output);
             $output = array();
-            $output[$layerName] = $nextOutput;
+            $output[$layer->getName()] = $nextOutput;
           }
           $response->setContent($nextOutput);

branches/david-execution_flow/src/renderer/AgaviPhpRenderer.class.php

@@ -33 +33 @@
    *                    including the dot.
    */
-  protected $extension = '.php';
-
+  protected $defaultExtension = '.php';
+  
   /**
-   * Retrieve the template engine associated with this view.
-   *
-   * Note: This will return null because PHP itself has no engine reference.
-   *
-   * @return     null
+   * @var        AgaviTemplateLayer Temporary storage for the template layer,
+   *                                used during rendering.
    */
-  public function getEngine()
-  {
-    return null;
-  }
-
+  protected $_layer = null;
+  
   /**
-   * Reset the engine for re-use
-   *
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
+   * @var        array Temporary storage for the template layer, used during
+   *                   rendering.
    */
-  protected function reset()
-  {
-    // nothing needs to be done for PHP
-  }
+  protected $_attributes = null;
+  
+  /**
+   * @var        array Temporary storage for the template layer, used during
+   *                   rendering.
+   */
+  protected $_slots = null;
   
   /**
@@ -67 +62 @@
   {
     // DO NOT USE VARIABLES IN HERE, THEY MIGHT INTERFERE WITH TEMPLATE VARS
+    $this->_layer = $layer;
+    $this->_attributes =& $attributes;
+    $this->_slots =& $slots;
+    unset($layer, $attributes, $slots);
     
     if($this->extractVars) {
-      extract($attributes, EXTR_REFS | EXTR_PREFIX_INVALID, '_');
+      extract($this->_attributes, EXTR_REFS | EXTR_PREFIX_INVALID, '_');
     } else {
-      ${$this->varName} =& $attributes;
+      ${$this->varName} =& $this->_attributes;
     }
     
     if($this->extractSlots === true || ($this->extractVars && $this->extractSlots !== false)) {
-      extract($slots, EXTR_REFS | EXTR_PREFIX_INVALID, '_');
+      extract($this->_slots, EXTR_REFS | EXTR_PREFIX_INVALID, '_');
     } else {
       if(!isset(${$this->slotsVarName})) {
         ${$this->slotsVarName} = array();
       }
-      ${$this->slotsVarName} = array_merge(${$this->slotsVarName}, $slots);
+      ${$this->slotsVarName} = array_merge(${$this->slotsVarName}, $this->_slots);
     }
     
-    $collisions = array_intersect(array_keys($this->assigns), array_keys($attributes));
+    $collisions = array_intersect(array_keys($this->assigns), array_keys($this->_attributes));
     if(count($collisions)) {
       throw new AgaviException('Could not import system objects due to variable name collisions ("' . implode('", "', $collisions) . '" already in use).');
     }
+    unset($collisions);
     
     extract($this->assigns);
@@ -92 +92 @@
     ob_start();