Changeset 1300

Timestamp:

05/03/06 09:03:12 (3 years ago)

Author:

fabien

Message:

* refactored partial and component support (now it instanciates a view as for actions)
* removed duplicated code
* output escaping support for partial and components
* partial and component cache (closes #406)
* fixed headers/css/js when caching an action
* fixed debug decoration
* added new helpers: get_component_slot(), get_component() and get_partial()
* added parameters to include_component_slot()
* refactored ignore cache parameter in sfWebDebug

Files:

• trunk/lib/action/sfAction.class.php (modified) (1 diff)
• trunk/lib/config/sfCacheConfigHandler.class.php (modified) (4 diffs)
• trunk/lib/controller/sfController.class.php (modified) (1 diff)
• trunk/lib/debug/sfWebDebug.class.php (modified) (2 diffs)
• trunk/lib/filter/sfCacheFilter.class.php (modified) (8 diffs)
• trunk/lib/helper/PartialHelper.php (modified) (5 diffs)
• trunk/lib/request/sfWebRequest.class.php (modified) (1 diff)
• trunk/lib/response/sfWebResponse.class.php (modified) (1 diff)
• trunk/lib/view/sfPHPView.class.php (modified) (13 diffs)
• trunk/lib/view/sfView.class.php (modified) (5 diffs)
• trunk/lib/view/sfViewCacheManager.class.php (modified) (7 diffs)

trunk/lib/action/sfAction.class.php

@@ -101 +101 @@
-    }
-
-    // ignore cache? (only in debug mode)
-    if (sfConfig::get('sf_debug') && $this->request->getParameter('ignore_cache', false, 'symfony/request/sfWebRequest') == true)
-    {
-      return 1;
-    }
-
-    $cache = $this->getContext()->getViewCacheManager();
-

trunk/lib/config/sfCacheConfigHandler.class.php

@@ -64 +64 @@
-                "{\n";
-
-
-
-
-
+
-
-      $data[] = "}\n";
@@ -75 +72 @@
-
-    // general cache configuration
-
-
-
-
-
-
+
+
+
-
-    // compile data
@@ -95 +89 @@
-    $data = array();
-
+    // activated?
+    $activate = $this->getConfigValue('activate', $actionName);
+
-    // cache type for this action (slot or page)
-    $type = $this->getConfigValue('type', $actionName);
-
-    // lifetime
-
+(!$activate) ? 0 : 
-
-    // client_lifetime
-
+(!$activate) ? 0 : 
-
-    // vary
@@ -112 +109 @@
-
-    // add cache information to cache manager
-this->
+
-                      $actionName, $type, $lifeTime, $clientLifetime, var_export($vary, true));
-

trunk/lib/controller/sfController.class.php

@@ -466 +466 @@
-        $class = $moduleClass;
-      }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-    return new $class();

trunk/lib/debug/sfWebDebug.class.php

@@ -376 +376 @@
-  }
-
-border_color, $bg_color
+new = false
-  {
-    if (!sfConfig::get('sf_web_debug'))
@@ -382 +382 @@
-      return $retval;
-    }
+
+    $border_color = $new ? '#f00' : '#f00';
+    $bg_color     = $new ? '#9ff' : '#ff9';
-
-    $cache = $this->context->getViewCacheManager();

trunk/lib/filter/sfCacheFilter.class.php

@@ -57 +57 @@
-      if (is_readable(sfConfig::get('sf_app_module_dir').'/'.$cacheConfigFile))
-      {
-
+
+
-        require(sfConfigCache::getInstance()->checkConfig(sfConfig::get('sf_app_module_dir_name').'/'.$cacheConfigFile));
-      }
@@ -64 +65 @@
-      list($uri, $suffix) = $this->cacheManager->getInternalUri('page');
-      $this->toSave[$uri.'_'.$suffix] = false;
-hasCacheConfig
+isCacheable
-      {
-        $inCache = $this->getPageCache($uri, $suffix);
@@ -79 +80 @@
-        list($uri, $suffix) = $this->cacheManager->getInternalUri('slot');
-        $this->toSave[$uri.'_'.$suffix] = false;
-hasCacheConfig
+isCacheable
-        {
-          $inCache = $this->getActionCache($uri, $suffix);
@@ -130 +131 @@
-
-          $this->setPageCache($uri, $suffix);
+
+          if (sfConfig::get('sf_web_debug'))
+          {
+            $content = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $suffix, $this->response->getContent(), true);
+            $this->response->setContent($content);
+          }
-        }
-
@@ -157 +164 @@
-    $this->cacheManager->set(serialize($this->response), $uri, $suffix);
-
-    if (sfConfig::get('sf_web_debug'))
-    {
-      $content = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $suffix, $this->response->getContent(), '#f00', '#9ff');
-      $this->response->setContent($content);
-    }
-
-    if (sfConfig::get('sf_logging_active'))
-    {
@@ -172 +173 @@
-  {
-    $context = $this->getContext();
-
-    // ignore cache?
-    if (sfConfig::get('sf_debug') && $this->request->getParameter('ignore_cache', false, 'symfony/request/sfWebRequest') == true)
-    {
-      if (sfConfig::get('sf_logging_active'))
-      {
-        $context->getLogger()->info('{sfCacheFilter} discard page cache for "'.$uri.' - '.$suffix.'"');
-      }
-
-      return false;
-    }
-
-    // get the current action information
@@ -195 +185 @@
-    }
-
-!
-
-$cachedResponse = unserialize($retval)
-  $cachedResponse->setContext($context);
-
-  $controller = $context->getController(
-  if ($controller->getRenderMode() == sfView::RENDER_VAR)
-
-    $controller->getActionStack()->getLastEntry()->setPresentation($cachedResponse->getContent()
-    $this->response->setContent('');
-  }
-else
-{
-    $context->setResponse($cachedResponse);
-
-    if (sfConfig::get('sf_web_debug'))
-  {
-
-    $this->response->setContent($content);
-  }
-}
-
-return true;
-
-
-fals
+=
+
+return false
+}
+
+$cachedResponse = unserialize($retval
+$cachedResponse->setContext($context);
+
+$controller = $context->getController(
+if ($controller->getRenderMode() == sfView::RENDER_VAR)
+{
+$controller->getActionStack()->getLastEntry()->setPresentation($cachedResponse->getContent());
+$this->response->setContent('');
+}
+
+{
+$context->setResponse($cachedResponse);
+
+if (sfConfig::get('sf_web_debug'))
+{
+  $content = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $suffix, $cachedResponse->getContent(), false);
+
+}
+
+
+tru
-  }
-
@@ -226 +216 @@
-  {
-    $content = $this->response->getParameter($uri.'_'.$suffix, null, 'symfony/cache');
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    if (sfConfig::get('sf_logging_active'))
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-  }
-}

trunk/lib/helper/PartialHelper.php

@@ -18 +18 @@
- */
-
-
+
+
+
+
+
+
-{
-  $context = sfContext::getInstance();
@@ -36 +41 @@
-  if ($componentSlot = $viewInstance->getComponentSlot($name))
-  {
-include_component($componentSlot[0], $componentSlot[1]
+return get_component($componentSlot[0], $componentSlot[1], $vars
-  }
-}
@@ -42 +47 @@
-function include_component($moduleName, $componentName, $vars = array())
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  $controller = $context->getController();
-
@@ -58 +101 @@
-
-  // initialize the action
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-  {
-    // component failed to initialize
@@ -101 +109 @@
-    throw new sfInitializationException($error);
-  }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  // partial is in another module?
-n
+templateN
-  if ($sep)
-  {
-type = substr($n
-filename = '_'.substr($name, $sep + 1).'.php'
+moduleName   = substr($templateN
+templateName = substr($templateName, $sep + 1)
-  }
-  else
-  {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      {
-ok = true
+retval = sfWebDebug::getInstance()->decorateContentWithDebug($uri, 'slot', $retval, false)
-      }
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
-

trunk/lib/request/sfWebRequest.class.php

@@ -419 +419 @@
-    $this->getParameterHolder()->addByRef($_POST);
-
+    // move symfony parameters in a protected namespace (parameters prefixed with sf_)
+    foreach ($this->getParameterHolder()->getAll() as $key => $value)
+    {
+      if (stripos($key, 'sf_') !== false)
+      {
+        $this->getParameterHolder()->remove($key);
+        $this->setParameter($key, $value, 'symfony/request/sfWebRequest');
+        unset($_GET[$key]);
+      }
+    }
+
-    if (sfConfig::get('sf_logging_active'))
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    }
-  }

trunk/lib/response/sfWebResponse.class.php

@@ -445 +445 @@
-  }
-
+  public function mergeProperties($response)
+  {
+    // add stylesheets
+    foreach (array('first', '', 'last') as $position)
+    {
+      $this->getParameterHolder()->add($response->getStylesheets($position), 'helper/asset/auto/stylesheet'.$position);
+    }
+
+    // add javascripts
+    foreach (array('first', '', 'last') as $position)
+    {
+      $this->getParameterHolder()->add($response->getJavascripts($position), 'helper/asset/auto/javascript'.$position);
+    }
+
+    // add headers
+    foreach ($response->getHttpHeaders() as $name => $values)
+    {
+      foreach ($values as $value)
+      {
+        $this->setHttpHeader($name, $value);
+      }
+    }
+  }
+
-  /**
-   * Execute the shutdown procedure.

trunk/lib/view/sfPHPView.class.php

@@ -20 +20 @@
-class sfPHPView extends sfView
-{
-  protected static
-    $coreHelpersLoaded = 0;
-
-  public function execute()
-  {
@@ -28 +25 @@
-
-  /**
-Assigns some common variables
+Returns an array with some variables that will be accessible
-   */
-  protected function getGlobalVars()
@@ -61 +58 @@
-  protected function loadCoreAndStandardHelpers()
-  {
-
+
+
+
-    {
-      return;
-    }
-
-self::
+
-
-    $core_helpers = array('Helper', 'Url', 'Asset', 'Tag', 'Escaping');
@@ -154 +153 @@
-
-    // store our current view
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    // require our configuration
@@ -160 +177 @@
-    require(sfConfigCache::getInstance()->checkConfig(sfConfig::get('sf_app_module_dir_name').'/'.$viewConfigFile));
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    else
@@ -175 +201 @@
-
-    // set template directory
-
-    // all directories to look for templates
-    $moduleName = $context->getModuleName();
-    $dirs = array(
-      // application
-      $this->getDirectory(),
-
-      // local plugin
-      sfConfig::get('sf_plugin_data_dir').'/modules/'.$moduleName.'/templates',
-
-      // core modules or global plugins
-      sfConfig::get('sf_symfony_data_dir').'/modules/'.$moduleName.'/templates',
-
-      // generated templates in cache
-      sfConfig::get('sf_module_cache_dir').'/auto'.ucfirst($moduleName).'/templates',
-    );
-
-    foreach ($dirs as $dir)
-    {
@@ -204 +213 @@
-    if (sfConfig::get('sf_logging_active'))
-    {
-'{sfPHPView} execute view for template "'.$templateName.$viewType.$this->extension.'"'
+sprintf('{sfPHPView} execute view for template "%s"', $templateFile)
-    }
-  }
@@ -243 +252 @@
-   *                the controller render mode is sfView::RENDER_VAR, otherwise null.
-   */
-
-
-
-
-
-
-
-
-
+
+
-    $retval = null;
-
+    $context = $this->getContext();
+
-    // get the render mode
-this->getContext()
+context
-
-    if ($mode != sfView::RENDER_NONE)
@@ -262 +266 @@
-      if (sfConfig::get('sf_cache'))
-      {
-
-
+
+
+
-        if ($cache !== null)
-        {
@@ -269 +274 @@
-          $retval = $cache['content'];
-          $vars   = $cache['vars'];
+          $response->mergeProperties($cache['response']);
-        }
+      }
+
+      // template variables
+      if ($templateVars === null)
+      {
+        $actionStackEntry = $context->getActionStack()->getLastEntry();
+        $actionInstance   = $actionStackEntry->getActionInstance();
+        $templateVars     = $actionInstance->getVarHolder()->getAll();
-      }
-
-      // assigns some variables to the template
-      $this->attribute_holder->add($this->getGlobalVars());
-actionInstance->getVarHolder()->getAll()
+templateVars
-
-      // render template if no cache
@@ -283 +297 @@
-
-        // render template file
+        $template = $this->getDirectory().'/'.$this->getTemplate();
-        $retval = $this->renderFile($template);
-
@@ -291 +306 @@
-        }
-
-
+ && $key !== null
-        {
-          $cache = array(
-            'content'   => $retval,
-actionInstance->getVarHolder()->getAll()
+templateVars
-            'view_name' => $this->viewName,
+            'response'  => $context->getResponse(),
-          );
-
+
+
+
+
+
+
-        }
-      }
@@ -311 +332 @@
-      if ($mode == sfView::RENDER_CLIENT)
-      {
-this->getContext()
+context
-      }
-    }

trunk/lib/view/sfView.class.php

@@ -55 +55 @@
-
-  /**
+   * Render a partial template.
+   */
+  const PARTIAL = 'Partial';
+
+  /**
+   * Render a global partial template.
+   */
+  const GLOBAL_PARTIAL = 'GlobalPartial';
+
+  /**
-   * Render the presentation to the client.
-   */
@@ -352 +362 @@
-        {
-          if ($request->hasError($name))
+          {
-            $this->setAttribute($name.'_error', $request->getError($name));
+          }
-          else
-          {
@@ -383 +395 @@
-
-    // set the currently executing module's template directory as the default template directory
-
-
-
+
-    $this->directory          = $this->decoratorDirectory;
-
@@ -442 +452 @@
-  {
-    return $this->decorator;
+  }
+
+  public function setDecorator ($boolean)
+  {
+    $this->decorator = (boolean) $boolean;
-  }
-
@@ -495 +510 @@
-   * render the presentation directly to the client and null will be returned.
-   *
+   * @param  array  An array with variables that will be extracted for the template
+   *                If empty, the current actions var holder will be extracted.
-   * @return string A string representing the rendered presentation, if
-
-
-
-
+
+
+
-
-  /**

trunk/lib/view/sfViewCacheManager.class.php

@@ -10 +10 @@
-
-/**
-Actions and T
+actions and t
- *
-is based on the PEAR_Cache_Liste class
+users viewCacheClassName to serialize cache
- * All cache files are stored in files in the [sf_root_dir].'/cache/'.[sf_app].'/html' directory.
- * To disable all caching, you can set to false [sf_cache] constant.
@@ -126 +126 @@
-      // we add cache information based on slot configuration for this module/action
-      $lifeTime = $this->getLifeTime($internalUri, 'slot');
-
-
-
-
+
-    }
-
@@ -185 +182 @@
-  }
-
-hasCacheConfig
+isCacheable
-  {
-    list($route_name, $params) = $this->controller->convertUrlStringToParameters($internalUri);
-    $entry = $params['module'].'_'.$params['action'].'_'.$suffix;
-
-
+
+
+
+
+
-    {
-      return true;
@@ -201 +202 @@
-  {
-    // no cache or no cache set for this action
-hasCacheConfig($internalUri, $suffix
+isCacheable($internalUri, $suffix) || $this->ignore(
-    {
-      return null;
@@ -216 +217 @@
-  public function has($internalUri, $suffix = 'slot')
-  {
-hasCacheConfig($internalUri, $suffix
+isCacheable($internalUri, $suffix) || $this->ignore(
-    {
-      return null;
@@ -229 +230 @@
-  }
-
+  protected function ignore()
+  {
+    // ignore cache parameter? (only available in debug mode)
+    if (sfConfig::get('sf_debug') && $this->getContext()->getRequest()->getParameter('sf_ignore_cache', false, 'symfony/request/sfWebRequest') == true)
+    {
+      if (sfConfig::get('sf_logging_active'))
+      {
+        $this->getContext()->getLogger()->info('{sfViewCacheManager} discard cache');
+      }
+
+      return true;
+    }
+
+    return false;
+  }
+
-  public function set($data, $internalUri, $suffix = 'slot')
-  {
-hasCacheConfig
+isCacheable
-    {
-      return false;
@@ -302 +319 @@
-  public function lastModified($internalUri, $suffix = 'slot')
-  {
-hasCacheConfig
+isCacheable
-    {
-      return null;