1. sfViewConfigHandler.class.php
  2. /**
 * sfViewConfigHandler allows you to configure views.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfViewConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfViewConfigHandler extends sfYamlConfigHandler
  4. {
  5.   /**
  6.    * Executes this configuration handler.
  7.    *
  8.    * @param array $configFiles An array of absolute filesystem path to a configuration file
  9.    *
  10.    * @return string Data to be written to a cache file
  11.    *
  12.    * @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
  13.    * @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
  14.    * @throws <b>sfInitializationException</b> If a view.yml key check fails
  15.    */
  16.   public function execute($configFiles)
  17.   {
  18.     // parse the yaml
  19.     $this->yamlConfig = self::getConfiguration($configFiles);
  21.     // init our data array
  22.     $data = array();
  24.     $data[] = "\$response = \$this->context->getResponse();\n\n";
  26.     // first pass: iterate through all view names to determine the real view name
  27.     $first = true;
  28.     foreach ($this->yamlConfig as $viewName => $values)
  29.     {
  30.       if ($viewName == 'all')
  31.       {
  32.         continue;
  33.       }
  35.       $data[] = ($first ? '' : 'else ')."if (\$this->actionName.\$this->viewName == '$viewName')\n".
  36.                 "{\n";
  37.       $data[] = $this->addTemplate($viewName);
  38.       $data[] = "}\n";
  40.       $first = false;
  41.     }
  43.     // general view configuration
  44.     $data[] = ($first ? '' : "else\n{")."\n";
  45.     $data[] = $this->addTemplate($viewName);
  46.     $data[] = ($first ? '' : "}")."\n\n";
  48.     // second pass: iterate through all real view names
  49.     $first = true;
  50.     foreach ($this->yamlConfig as $viewName => $values)
  51.     {
  52.       if ($viewName == 'all')
  53.       {
  54.         continue;
  55.       }
  57.       $data[] = ($first ? '' : 'else ')."if (\$templateName.\$this->viewName == '$viewName')\n".
  58.                 "{\n";
  60.       $data[] = $this->addLayout($viewName);
  61.       $data[] = $this->addComponentSlots($viewName);
  62.       $data[] = $this->addHtmlHead($viewName);
  63.       $data[] = $this->addEscaping($viewName);
  65.       $data[] = $this->addHtmlAsset($viewName);
  67.       $data[] = "}\n";
  69.       $first = false;
  70.     }
  72.     // general view configuration
  73.     $data[] = ($first ? '' : "else\n{")."\n";
  75.     $data[] = $this->addLayout();
  76.     $data[] = $this->addComponentSlots();
  77.     $data[] = $this->addHtmlHead();
  78.     $data[] = $this->addEscaping();
  80.     $data[] = $this->addHtmlAsset();
  81.     $data[] = ($first ? '' : "}")."\n";
  83.     // compile data
  84.     $retval = sprintf("<?php\n".
  85.                       "// auto-generated by sfViewConfigHandler\n".
  86.                       "// date: %s\n%s\n",
  87.                       date('Y/m/d H:i:s'), implode('', $data));
  89.     return $retval;
  90.   }
  92.   /**
  93.    * Adds a component slot statement to the data.
  94.    *
  95.    * @param string $viewName The view name
  96.    *
  97.    * @return string The PHP statement
  98.    */
  99.   protected function addComponentSlots($viewName = '')
  100.   {
  101.     $data = '';
  103.     $components = $this->mergeConfigValue('components', $viewName);
  104.     foreach ($components as $name => $component)
  105.     {
  106.       if (!is_array($component) || count($component) < 1)
  107.       {
  108.         $component = array(null, null);
  109.       }
  111.       $data .= "  \$this->setComponentSlot('$name', '{$component[0]}', '{$component[1]}');\n";
  112.       $data .= "  if (sfConfig::get('sf_logging_enabled')) \$this->context->getEventDispatcher()->notify(new sfEvent(\$this, 'application.log', array(sprintf('Set component \"%s\" (%s/%s)', '$name', '{$component[0]}', '{$component[1]}'))));\n";
  113.     }
  115.     return $data;
  116.   }
  118.   /**
  119.    * Adds a template setting statement to the data.
  120.    *
  121.    * @param string $viewName The view name
  122.    *
  123.    * @return string The PHP statement
  124.    */
  125.   protected function addTemplate($viewName = '')
  126.   {
  127.     $data = '';
  129.     $templateName = $this->getConfigValue('template', $viewName);
  130.     $defaultTemplateName = $templateName ? "'$templateName'" : '$this->actionName';
  132.     $data .= "  \$templateName = sfConfig::get('symfony.view.'.\$this->moduleName.'_'.\$this->actionName.'_template', $defaultTemplateName);\n";
  133.     $data .= "  \$this->setTemplate(\$templateName.\$this->viewName.\$this->getExtension());\n";
  135.     return $data;
  136.   }
  138.   /**
  139.    * Adds a layout statement statement to the data.
  140.    *
  141.    * @param string $viewName The view name
  142.    *
  143.    * @return string The PHP statement
  144.    */
  145.   protected function addLayout($viewName = '')
  146.   {
  147.     // true if the user set 'has_layout' to true or set a 'layout' name for this specific action
  148.     $hasLocalLayout = isset($this->yamlConfig[$viewName]['layout']) || (isset($this->yamlConfig[$viewName]) && array_key_exists('has_layout', $this->yamlConfig[$viewName]));
  150.     // the layout value
  151.     $layout = $this->getConfigValue('has_layout', $viewName) ? $this->getConfigValue('layout', $viewName) : false;
  153.     // the user set a decorator in the action
  154.     $data = <<<EOF
  155.   if (null !== \$layout = sfConfig::get('symfony.view.'.\$this->moduleName.'_'.\$this->actionName.'_layout'))
  156.   {
  157.     \$this->setDecoratorTemplate(false === \$layout ? false : \$layout.\$this->getExtension());
  158.   }
  159. EOF;
  161.     if ($hasLocalLayout)
  162.     {
  163.       // the user set a decorator in view.yml for this action
  164.       $data .= <<<EOF
  166.   else
  167.   {
  168.     \$this->setDecoratorTemplate('' == '$layout' ? false : '$layout'.\$this->getExtension());
  169.   }
  171. EOF;
  172.     }
  173.     else
  174.     {
  175.       // no specific configuration
  176.       // set the layout to the 'all' view.yml value except if:
  177.       //   * the decorator template has already been set by "someone" (via view.configure_format for example)
  178.       //   * the request is an XMLHttpRequest request
  179.       $data .= <<<EOF
  181.   else if (null === \$this->getDecoratorTemplate() && !\$this->context->getRequest()->isXmlHttpRequest())
  182.   {
  183.     \$this->setDecoratorTemplate('' == '$layout' ? false : '$layout'.\$this->getExtension());
  184.   }
  186. EOF;
  187.     }
  189.     return $data;
  190.   }
  192.   /**
  193.    * Adds http metas and metas statements to the data.
  194.    *
  195.    * @param string $viewName The view name
  196.    *
  197.    * @return string The PHP statement
  198.    */
  199.   protected function addHtmlHead($viewName = '')
  200.   {
  201.     $data = array();
  203.     foreach ($this->mergeConfigValue('http_metas', $viewName) as $httpequiv => $content)
  204.     {
  205.       $data[] = sprintf("  \$response->addHttpMeta('%s', '%s', false);", $httpequiv, str_replace('\'', '\\\'', $content));
  206.     }
  208.     foreach ($this->mergeConfigValue('metas', $viewName) as $name => $content)
  209.     {
  210.       $data[] = sprintf("  \$response->addMeta('%s', '%s', false, false);", $name, str_replace('\'', '\\\'', preg_replace('/&amp;(?=\w+;)/', '&', htmlspecialchars($content, ENT_QUOTES, sfConfig::get('sf_charset')))));
  211.     }
  213.     return implode("\n", $data)."\n";
  214.   }
  216.   /**
  217.    * Adds stylesheets and javascripts statements to the data.
  218.    *
  219.    * @param string $viewName The view name
  220.    *
  221.    * @return string The PHP statement
  222.    */
  223.   protected function addHtmlAsset($viewName = '')
  224.   {
  225.     // Merge the current view's stylesheets with the app's default stylesheets
  226.     $stylesheets = $this->mergeConfigValue('stylesheets', $viewName);
  227.     $css = $this->addAssets('Stylesheet', $stylesheets);
  229.     // Merge the current view's javascripts with the app's default javascripts
  230.     $javascripts = $this->mergeConfigValue('javascripts', $viewName);
  231.     $js = $this->addAssets('Javascript', $javascripts);
  233.     return implode("\n", array_merge($css, $js))."\n";
  234.   }
  236.   /**
  237.    * Creates a list of add$Type PHP statements for the given type and config.
  238.    *
  239.    * @param string $type of asset. Requires an sfWebResponse->add$Type(string, string, array) method
  240.    *
  241.    * @return array ist of add$Type PHP statements
  242.    */
  243.   private function addAssets($type, $assets){
  244.     $tmp = array();
  245.     foreach ((array) $assets as $asset)
  246.     {
  247.       $position = '';
  248.       if (is_array($asset))
  249.       {
  250.         $key = key($asset);
  251.         $options = $asset[$key];
  252.         if (isset($options['position']))
  253.         {
  254.           $position = $options['position'];
  255.           unset($options['position']);
  256.         }
  257.       }
  258.       else
  259.       {
  260.         $key = $asset;
  261.         $options = array();
  262.       }
  264.       if ('-*' == $key)
  265.       {
  266.         $tmp = array();
  267.       }
  268.       else if ('-' == $key[0])
  269.       {
  270.         unset($tmp[substr($key, 1)]);
  271.       }
  272.       else
  273.       {
  274.         $tmp[$key] = sprintf("  \$response->add%s('%s', '%s', %s);", $type, $key, $position, str_replace("\n", '', var_export($options, true)));
  275.       }
  276.     }
  277.     return array_values($tmp);
  278.   }
  280.   /**
  281.    * Adds an escaping statement to the data.
  282.    *
  283.    * @param string $viewName The view name
  284.    *
  285.    * @return string The PHP statement
  286.    */
  287.   protected function addEscaping($viewName = '')
  288.   {
  289.     $data = array();
  291.     $escaping = $this->getConfigValue('escaping', $viewName);
  293.     if (isset($escaping['method']))
  294.     {
  295.       $data[] = sprintf("  \$this->getAttributeHolder()->setEscapingMethod(%s);", var_export($escaping['method'], true));
  296.     }
  298.     return implode("\n", $data)."\n";
  299.   }
  301.   /**
  302.    * @see sfConfigHandler
  303.    */
  304.   static public function getConfiguration(array $configFiles)
  305.   {
  306.     return self::mergeConfig(self::parseYamls($configFiles));
  307.   }
  309.   static protected function mergeConfig($config)
  310.   {
  311.     // merge javascripts and stylesheets
  312.     $config['all']['stylesheets'] = array_merge(isset($config['default']['stylesheets']) && is_array($config['default']['stylesheets']) ? $config['default']['stylesheets'] : array(), isset($config['all']['stylesheets']) && is_array($config['all']['stylesheets']) ? $config['all']['stylesheets'] : array());
  313.     unset($config['default']['stylesheets']);
  315.     $config['all']['javascripts'] = array_merge(isset($config['default']['javascripts']) && is_array($config['default']['javascripts']) ? $config['default']['javascripts'] : array(), isset($config['all']['javascripts']) && is_array($config['all']['javascripts']) ? $config['all']['javascripts'] : array());
  316.     unset($config['default']['javascripts']);
  318.     // merge default and all
  319.     $config['all'] = sfToolkit::arrayDeepMerge(
  320.       isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
  321.       isset($config['all']) && is_array($config['all']) ? $config['all'] : array()
  322.     );
  324.     unset($config['default']);
  326.     return self::replaceConstants($config);
  327.   }
  328. }
Debug toolbar