Changeset 2629

Timestamp:

07/29/08 13:50:05 (5 months ago)

Author:

david

Message:

Dumped "xhtml" output type from sample app and introduced a replacement, closes #802

Location:

branches/0.11

Files:

• CHANGELOG (modified) (1 diff)
• samples/app/config/output_types.xml (modified) (3 diffs)
• samples/app/config/routing.xml (modified) (1 diff)
• samples/app/lib/view/AgaviSampleAppBaseView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/SearchEngineSpamErrorView.class.php (modified) (1 diff)
• samples/app/modules/Default/views/SearchEngineSpamSuccessView.class.php (modified) (1 diff)

branches/0.11/CHANGELOG

@@ -8 +8 @@
 ADD: Support for doctrine connection settings and options (#788) (David)
 
+CHG: Dump "xhtml" output type from sample app and introduce a replacement (#802) (David)
 CHG: Assigning of "inner" content to $slots template array should be configurable (#793) (David)
 

branches/0.11/samples/app/config/output_types.xml

@@ -2 +2 @@
 <configurations xmlns="http://agavi.org/agavi/1.0/config" xmlns:xi="http://www.w3.org/2001/XInclude">
 
+  <!-- the sandbox. we can put anything in here. very useful for sharing stuff inside the document using XIncludes -->
   <sandbox>
-
-    <renderers default="php">
-      
-      <renderer name="php" class="AgaviPhpRenderer">
-        <parameter name="assigns">
-          <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>
-          <parameter name="request_data">rd</parameter>
-        </parameter>
-      </renderer>
-      
-    </renderers>
-    
-    <layouts default="default">
-      
-      <layout name="default">
-        <layer name="content" />
-        <layer name="decorator">
-          <slot name="menu" module="Default" action="Menu" />
-          <parameter name="directory">%core.template_dir%</parameter>
-          <parameter name="template">Master</parameter>
-        </layer>
-      </layout>
-      
-      <layout name="slot">
-        <layer name="content" />
-      </layout>
-      
-    </layouts>
-
+    <!-- our common layers that all layouts use. only the content layer in here, and empty, but who knows! -->
+    <layers>
+      <layer name="content" />
+    </layers>
   </sandbox>
 
@@ -42 +14 @@
 
       <output_type name="html">
-        <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:renderers)" />
-        <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:layouts)" />
-        
+        <renderers default="php">
+
+          <renderer name="php" class="AgaviPhpRenderer">
+            <parameter name="assigns">
+              <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>
+              <parameter name="request_data">rd</parameter>
+            </parameter>
+          </renderer>
+
+        </renderers>
+
+        <layouts default="default">
+
+          <layout name="default">
+            <!-- include common layer definitions from the sandbox -->
+            <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:layers/*)" />
+            <!-- and then define those special tp this layout -->
+            <layer name="decorator">
+              <slot name="menu" module="Default" action="Menu" />
+              <parameter name="directory">%core.template_dir%</parameter>
+              <parameter name="template">Master</parameter>
+            </layer>
+          </layout>
+
+          <layout name="slot">
+            <!-- include common layer definitions from the sandbox -->
+            <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:layers/*)" />
+          </layout>
+
+        </layouts>
+
         <parameter name="http_headers">
           <parameter name="Content-Type">text/html; charset=UTF-8</parameter>
@@ -50 +54 @@
       </output_type>
 
-      <output_type name="xhtml">
-        <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:renderers)" />
-        <xi:include xpointer="xmlns(a=http://agavi.org/agavi/1.0/config) xpointer(/a:configurations/a:sandbox/a:layouts)" />
-        
+      <output_type name="json">
         <parameter name="http_headers">
-          <parameter name="Content-Type">application/xhtml+xml; charset=UTF-8</parameter>
+          <parameter name="Content-Type">application/json; charset=UTF-8</parameter>
         </parameter>
       </output_type>

branches/0.11/samples/app/config/routing.xml

@@ -11 +11 @@
       </route>
       
-      <!-- If the HTTP Accept: header contains "application/xhtml+xml", set the output type to "xhtml". Look at output_types.xml for the declaration of that output type. Execution will not stop if this route matches. -->
-      <route pattern="application/xhtml+xml" source="_SERVER[HTTP_ACCEPT]" output_type="xhtml" stop="false" />
-    
+      <!-- If the HTTP Accept: header contains "application/json" (i.e. if you do an XMLHTTPRequest with one of the usual JS frameworks), set the output type to "json". Look at output_types.xml for the declaration of that output type. Execution will not stop if this route matches. This is nice for making XMLHTTPRequest calls. -->
+      <route pattern="application/json" source="_SERVER[HTTP_ACCEPT]" output_type="json" stop="false" />
+      
       <route name="disabled" pattern="^/disabled" module="Disabled" action="Index" />
       

branches/0.11/samples/app/lib/view/AgaviSampleAppBaseView.class.php

@@ -58 +58 @@
   }
   
-  public function executeXhtml(AgaviRequestDataHolder $rd)
+  public function executeJson(AgaviRequestDataHolder $rd)
   {
-    if(method_exists($this, 'executeHtml')) {
-      return $this->executeHtml($rd);
-    } else {
-      return $this->execute($rd);
-    }
+    throw new AgaviViewException(sprintf(
+      'The View "%1$s" does not implement an "execute%3$s()" method to serve '.
+      'the Output Type "%2$s". It is recommended that you change the code of '.
+      'the method "execute%3$s()" in the base View "%4$s" that is throwing '.
+      'this exception to deal with this situation in a more appropriate '.
+      'way, for example by forwarding to the default 404 error action, or by '.
+      'showing some other meaningful error message to the user which explains '.
+      'that the operation was unsuccessful beacuse the desired Output Type is '.
+      'not implemented.',
+      get_class($this),
+      $this->container->getOutputType()->getName(),
+      ucfirst(strtolower($this->container->getOutputType()->getName())),
+      get_class()
+    ));
   }
   

branches/0.11/samples/app/modules/Default/views/SearchEngineSpamErrorView.class.php

@@ -10 +10 @@
   {
     return $this->createForwardContainer(AgaviConfig::get('actions.error_404_module'), AgaviConfig::get('actions.error_404_action'));
+  }
+
+  /**
+   * Execute any presentation logic for JSON requests.
+   */
+  public function executeJson(AgaviRequestDataHolder $rd)
+  {
+    return json_encode(
+      array(
+        '_error' => 404,
+      )
+    );
   }
 

branches/0.11/samples/app/modules/Default/views/SearchEngineSpamSuccessView.class.php

@@ -14 +14 @@
     // set the title
     $this->setAttribute('title', $this->getContext()->getTranslationManager()->_('Congratulations!', 'default.SearchEngineSpam'));
+  }
+
+  /**
+   * Execute any presentation logic for JSON requests.
+   */
+  public function executeJson(AgaviRequestDataHolder $rd)
+  {
+    return json_encode(
+      array(
+        'product_price' => $this->getAttribute('product_price'),
+      )
+    );
   }