1. sfCacheConfigHandler.class.php
  2. /**
 * sfCacheConfigHandler allows you to configure cache.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCacheConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfCacheConfigHandler extends sfYamlConfigHandler
  4. {
  5.   protected
  6.     $cacheConfig = array();
  8.   /**
  9.    * Executes this configuration handler.
  10.    *
  11.    * @param array $configFiles An array of absolute filesystem path to a configuration file
  12.    *
  13.    * @return string Data to be written to a cache file
  14.    *
  15.    * @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
  16.    * @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
  17.    * @throws <b>sfInitializationException</b> If a cache.yml key check fails
  18.    */
  19.   public function execute($configFiles)
  20.   {
  21.     // parse the yaml
  22.     $this->yamlConfig = self::getConfiguration($configFiles);
  24.     // iterate through all action names
  25.     $data  = array();
  26.     $first = true;
  27.     foreach ($this->yamlConfig as $actionName => $values)
  28.     {
  29.       if ($actionName == 'all')
  30.       {
  31.         continue;
  32.       }
  34.       $data[] = $this->addCache($actionName);
  36.       $first = false;
  37.     }
  39.     // general cache configuration
  40.     $data[] = $this->addCache('DEFAULT');
  42.     // compile data
  43.     $retval = sprintf("<?php\n".
  44.                       "// auto-generated by sfCacheConfigHandler\n".
  45.                       "// date: %s\n%s\n",
  46.                       date('Y/m/d H:i:s'), implode('', $data));
  48.     return $retval;
  49.   }
  51.   /**
  52.    * Returns a single addCache statement.
  53.    *
  54.    * @param string $actionName The action name
  55.    *
  56.    * @return string PHP code for the addCache statement
  57.    */
  58.   protected function addCache($actionName = '')
  59.   {
  60.     $data = array();
  62.     // enabled?
  63.     $enabled = $this->getConfigValue('enabled', $actionName);
  65.     // cache with or without loayout
  66.     $withLayout = $this->getConfigValue('with_layout', $actionName) ? 'true' : 'false';
  68.     // lifetime
  69.     $lifeTime = !$enabled ? '0' : $this->getConfigValue('lifetime', $actionName, '0');
  71.     // client_lifetime
  72.     $clientLifetime = !$enabled ? '0' : $this->getConfigValue('client_lifetime', $actionName, $lifeTime, '0');
  74.     // contextual
  75.     $contextual = $this->getConfigValue('contextual', $actionName) ? 'true' : 'false';
  77.     // vary
  78.     $vary = $this->getConfigValue('vary', $actionName, array());
  79.     if (!is_array($vary))
  80.     {
  81.       $vary = array($vary);
  82.     }
  84.     // add cache information to cache manager
  85.     $data[] = sprintf("\$this->addCache(\$moduleName, '%s', array('withLayout' => %s, 'lifeTime' => %s, 'clientLifeTime' => %s, 'contextual' => %s, 'vary' => %s));\n",
  86.                       $actionName, $withLayout, $lifeTime, $clientLifetime, $contextual, str_replace("\n", '', var_export($vary, true)));
  88.     return implode("\n", $data);
  89.   }
  91.   /**
  92.    * @see sfConfigHandler
  93.    */
  94.   static public function getConfiguration(array $configFiles)
  95.   {
  96.     return self::flattenConfiguration(self::parseYamls($configFiles));
  97.   }
  98. }
Debug toolbar