1. sfRootConfigHandler.class.php
  2. /**
 * sfRootConfigHandler allows you to specify configuration handlers for the
 * application or on a module level.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfRootConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfRootConfigHandler 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 sfConfigurationException If a requested configuration file does not exist or is not readable
  13.    * @throws sfParseException If a requested configuration file is improperly formatted
  14.    */
  15.   public function execute($configFiles)
  16.   {
  17.     // parse the yaml
  18.     $config = self::getConfiguration($configFiles);
  20.     // determine if we're loading the system config_handlers.yml or a module config_handlers.yml
  21.     $moduleLevel = ($this->getParameterHolder()->get('module_level') === true) ? true : false;
  23.     if ($moduleLevel)
  24.     {
  25.       // get the current module name
  26.       $moduleName = $this->getParameterHolder()->get('module_name');
  27.     }
  29.     // init our data and includes arrays
  30.     $data     = array();
  31.     $includes = array();
  33.     // let's do our fancy work
  34.     foreach ($config as $category => $keys)
  35.     {
  36.       if ($moduleLevel)
  37.       {
  38.         // module-level registration, so we must prepend the module
  39.         // root to the category
  40.         $category = 'modules/'.$moduleName.'/'.$category;
  41.       }
  43.       if (!isset($keys['class']))
  44.       {
  45.         // missing class key
  46.         throw new sfParseException(sprintf('Configuration file "%s" specifies category "%s" with missing class key.', $configFiles[0], $category));
  47.       }
  49.       $class = $keys['class'];
  51.       if (isset($keys['file']))
  52.       {
  53.         if (!is_readable($keys['file']))
  54.         {
  55.           // handler file doesn't exist
  56.           throw new sfParseException(sprintf('Configuration file "%s" specifies class "%s" with nonexistent or unreadable file "%s".', $configFiles[0], $class, $keys['file']));
  57.         }
  59.         // append our data
  60.         $includes[] = sprintf("require_once('%s');", $keys['file']);
  61.       }
  63.       // parse parameters
  64.       $parameters = (isset($keys['param']) ? var_export($keys['param'], true) : null);
  66.       // append new data
  67.       $data[] = sprintf("\$this->handlers['%s'] = new %s(%s);", $category, $class, $parameters);
  68.     }
  70.     // compile data
  71.     $retval = sprintf("<?php\n" .
  72.                       "// auto-generated by sfRootConfigHandler\n".
  73.                       "// date: %s\n%s\n%s\n",
  74.                       date('Y/m/d H:i:s'), implode("\n", $includes), implode("\n", $data));
  76.     return $retval;
  77.   }
  79.   /**
  80.    * @see sfConfigHandler
  81.    */
  82.   static public function getConfiguration(array $configFiles)
  83.   {
  84.     $config = self::replaceConstants(self::parseYamls($configFiles));
  86.     foreach ($config as $category => $keys)
  87.     {
  88.       if (isset($keys['file']))
  89.       {
  90.         $config[$category]['file'] = self::replacePath($keys['file']);
  91.       }
  92.     }
  94.     return $config;
  95.   }
  96. }
Debug toolbar