Changeset 1495

Timestamp:

01/14/07 06:55:44 (2 years ago)

Author:

david

Message:

first take on response merging stuff, refs #373

Location:

branches/david-execution_flow/src

Files:

• controller/AgaviController.class.php (modified) (2 diffs)
• controller/AgaviExecutionContainer.class.php (modified) (1 diff)
• filter/AgaviExecutionFilter.class.php (modified) (2 diffs)
• response/AgaviResponse.class.php (modified) (1 diff)
• response/AgaviWebResponse.class.php (modified) (5 diffs)

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

@@ -116 +116 @@
    * Create and initialize new execution container instance.
    *
-   * @param      string The name of the module.
-   * @param      string The name of the action.
-   * @param      array  Optional additional parameters.
-   * @param      string The name of the initial output type to set.
+   * @param      string          The name of the module.
+   * @param      string          The name of the action.
+   * @param      array           Optional additional parameters.
+   * @param      AgaviOutputType Optional name of an initial output type to set.
    *
    * @return     AgaviExecutionContainer A new execution container instance,
@@ -129 +129 @@
   public function createExecutionContainer($moduleName = null, $actionName = null, array $parameters = array(), AgaviOutputType $outputType = null)
   {
-    // create a new filter chain
+    // create a new execution container
     $ecfi = $this->context->getFactoryInfo('execution_container');
     $container = new $ecfi['class']();

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

@@ -101 +101 @@
   
   /**
+   * Creates a new container instance with the same output type as this one.
+   *
+   * @param      string          The name of the module.
+   * @param      string          The name of the action.
+   * @param      array           Optional additional parameters.
+   * @param      AgaviOutputType Optional name of an initial output type to set.
+   *
+   * @return     AgaviExecutionContainer A new execution container instance,
+   *                                     fully initialized.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function createExecutionContainer($moduleName = null, $actionName = null, array $parameters = array(), AgaviOutputType $outputType = null)
+  {
+    if($outputType === null) {
+      $outputType = $this->getOutputType();
+    }
+    return $this->context->getController()->createExecutionContainer($moduleName, $actionName, $parameters, $outputType);
+  }
+  
+  /**
    * Start execution.
    *

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

@@ -366 +366 @@
         $request->toggleLock($key);
         
-        if(is_array($next) && count($next) >= 2) {
-          $container->setNext($controller->createExecutionContainer($next[0], $next[1], isset($next[2]) ? $next[2] : array(), isset($next[3]) ? ($next[3] instanceof AgaviOutputType ? $next[3] : $controller->getOutputType($next[3])) : $container->getOutputType()));
+        if($next instanceof AgaviExecutionContainer) {
+          $container->setNext($next);
         } else {
           $attributes =& $viewInstance->getAttributes();
@@ -376 +376 @@
             foreach($layer->getSlots() as $slotName => $slotContainer) {
               $slotResponse = $slotContainer->execute();
-              if($response) {
+              // FIXME: this if is always true
+              if($slotResponse) {
                 // set the presentation data as a template attribute
                 $output[$name] = $slotResponse->getContent();
-                // $response->merge($response->exportInfo());
+                // let our response grab the stuff it needs from the slot's response
+                $response->merge($slotResponse);
               } else {
                 $output[$name] = null;

branches/david-execution_flow/src/response/AgaviResponse.class.php

@@ -145 +145 @@
   
   /**
+   * Import response metadata from another response.
+   *
+   * @param      AgaviResponse The other response to import information from.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  abstract public function merge(AgaviResponse $otherResponse);
+  
+  /**
    * Clear all data for this Response.
    *

branches/david-execution_flow/src/response/AgaviWebResponse.class.php

@@ -173 +173 @@
   
   /**
+   * Import response metadata (headers, cookies) from another response.
+   *
+   * @param      AgaviResponse The other response to import information from.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function merge(AgaviResponse $otherResponse)
+  {
+    if($otherResponse instanceof AgaviWebResponse) {
+      foreach($otherResponse->getHttpHeaders() as $name => $value) {
+        if(!$this->hasHttpHeader($name)) {
+          $this->setHttpHeader($name, $value);
+        }
+      }
+      foreach($otherResponse->getCookies() as $name => $cookie) {
+        if(!$this->hasCookie($name)) {
+          $this->setCookie($name, $cookie['value'], $cookie['lifetime'], $cookie['path'], $cookie['domain'], $cookie['secure'], $cookie['httpOnly']);
+        }
+      }
+    }
+  }
+  
+  
+  /**
    * Sets a HTTP status code for the response.
    *
@@ -304 +329 @@
    *
    * @param      string A cookie name.
-   * @param      mixed Data to store into a cookie. If null or empty cookie
-   *                   will be tried to be removed.
+   * @param      mixed  Data to store into a cookie. If null or empty cookie
+   *                    will be tried to be removed.
    * @param      int    The lifetime of the cookie in seconds. When you pass 0 
-   *                    the cookie will be valid until the  browser gets closed.
+   *                    the cookie will be valid until the browser is closed.
    * @param      string The path on the server the cookie will be available on.
    * @param      string The domain the cookie is available on.
@@ -313 +338 @@
    *                    over a secure HTTPS connection.
    * @param      bool   Whether the cookie will be made accessible only through
-   *                    the HTTP protocol.
+   *                    the HTTP protocol, and not to client-side scripts.
    *
    * @author     Veikko Makinen <mail@veikkomakinen.com>
@@ -319 +344 @@
    * @since      0.11.0
    */
-  public function setCookie($name, $value, $lifetime = null, $path = null, $domain = null, $secure = null, $httpOnly = false)
-  {
-    $lifetime = isset($lifetime) ? $lifetime : $this->cookieConfig['lifetime'];
-    $path     = isset($path)     ? $path     : $this->cookieConfig['path'];
-    $domain   = isset($domain)   ? $domain   : $this->cookieConfig['domain'];
-    $secure   = (bool) (isset($secure)   ? $secure   : $this->cookieConfig['secure']);
-    $httpOnly = (bool) (isset($httpOnly) ? $httpOnly : $this->cookieConfig['httpOnly']);
+  public function setCookie($name, $value, $lifetime = null, $path = null, $domain = null, $secure = null, $httpOnly = null)
+  {
+    $lifetime =         $lifetime === null ? $lifetime : $this->cookieConfig['lifetime'];
+    $path     =         $path === null     ? $path     : $this->cookieConfig['path'];
+    $domain   =         $domain === null   ? $domain   : $this->cookieConfig['domain'];
+    $secure   = (bool) ($secure === null   ? $secure   : $this->cookieConfig['secure']);
+    $httpOnly = (bool) ($httpOnly === null ? $httpOnly : $this->cookieConfig['httpOnly']);
 
     $this->cookies[$name] = array(
@@ -336 +361 @@
     );
   }
-
+  
+  /**
+   * Get a cookie set for later sending.
+   *
+   * @param      string The name of the cookie.
+   *
+   * @return     array An associative array containing the cookie data or null
+   *                   if no cookie with that name has been set.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getCookie($name)
+  {
+    if(isset($this->cookies[$name])) {
+      return $this->cookies[$name];
+    }
+  }
+  
+  /**
+   * Check if a cookie has been set for later sending.
+   *
+   * @param      string The name of the cookie.
+   *
+   * @return     bool True if a cookie with that name has been set, else false.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function hasCookie($name)
+  {
+    return isset($this->cookies[$name]);
+  }
+  
+  /**
+   * Remove a cookie previously set for later sending.
+   *
+   * This method cannot be used to unset a cookie. It's purpose is to remove a
+   * cookie from the list of cookies to be sent along with the response. If you
+   * wish to remove an existing cookie, use the setCookie method and supply null
+   * as the value.
+   *
+   * @param      string The name of the cookie.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function removeCookie($name)
+  {
+    if(isset($this->cookies[$name])) {
+      unset($this->cookies[$name]);
+    }
+  }
+  
+  /**
+   * Get a list of cookies set for later sending.
+   *
+   * @return     array An associative array of cookie names (key) and cookie
+   *                   information (value, associative array).
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getCookies()
+  {
+    return $this->cookies;
+  }
+  
   /**
    * Remove the HTTP header set for the response