1. sfYamlConfigHandler.class.php
  2. /**
 * sfYamlConfigHandler is a base class for YAML (.yml) configuration handlers. This class
 * provides a central location for parsing YAML files.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfYamlConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfYamlConfigHandler extends sfConfigHandler
  4. {
  5.   protected
  6.     $yamlConfig = null;
  8.   /**
  9.    * Parses an array of YAMLs files and merges them in one configuration array.
  10.    *
  11.    * @param array $configFiles An array of configuration file paths
  12.    *
  13.    * @return array A merged configuration array
  14.    */
  15.   static public function parseYamls($configFiles)
  16.   {
  17.     $config = array();
  18.     foreach ($configFiles as $configFile)
  19.     {
  20.       // the first level is an environment and its value must be an array
  21.       $values = array();
  22.       foreach (self::parseYaml($configFile) as $env => $value)
  23.       {
  24.         if (null !== $value)
  25.         {
  26.           $values[$env] = $value;
  27.         }
  28.       }
  30.       $config = sfToolkit::arrayDeepMerge($config, $values);
  31.     }
  33.     return $config;
  34.   }
  36.   /**
  37.    * Parses a YAML (.yml) configuration file.
  38.    *
  39.    * @param string $configFile An absolute filesystem path to a configuration file
  40.    *
  41.    * @return string A parsed .yml configuration
  42.    *
  43.    * @throws sfConfigurationException If a requested configuration file does not exist or is not readable
  44.    * @throws sfParseException If a requested configuration file is improperly formatted
  45.    */
  46.   static public function parseYaml($configFile)
  47.   {
  48.     if (!is_readable($configFile))
  49.     {
  50.       // can't read the configuration
  51.       throw new sfConfigurationException(sprintf('Configuration file "%s" does not exist or is not readable.', $configFile));
  52.     }
  54.     // parse our config
  55.     $config = sfYaml::load($configFile);
  57.     if ($config === false)
  58.     {
  59.       // configuration couldn't be parsed
  60.       throw new sfParseException(sprintf('Configuration file "%s" could not be parsed', $configFile));
  61.     }
  63.     return null === $config ? array() : $config;
  64.   }
  66.   /**
  67.    * Merges configuration values for a given key and category.
  68.    *
  69.    * @param string $keyName  The key name
  70.    * @param string $category The category name
  71.    *
  72.    * @return string The value associated with this key name and category
  73.    */
  74.   protected function mergeConfigValue($keyName, $category)
  75.   {
  76.     $values = array();
  78.     if (isset($this->yamlConfig['all'][$keyName]) && is_array($this->yamlConfig['all'][$keyName]))
  79.     {
  80.       $values = $this->yamlConfig['all'][$keyName];
  81.     }
  83.     if ($category && isset($this->yamlConfig[$category][$keyName]) && is_array($this->yamlConfig[$category][$keyName]))
  84.     {
  85.       $values = array_merge($values, $this->yamlConfig[$category][$keyName]);
  86.     }
  88.     return $values;
  89.   }
  91.   /**
  92.    * Gets a configuration value for a given key and category.
  93.    *
  94.    * @param string $keyName      The key name
  95.    * @param string $category     The category name
  96.    * @param string $defaultValue The default value
  97.    *
  98.    * @return string The value associated with this key name and category
  99.    */
  100.   protected function getConfigValue($keyName, $category, $defaultValue = null)
  101.   {
  102.     if (isset($this->yamlConfig[$category][$keyName]))
  103.     {
  104.       return $this->yamlConfig[$category][$keyName];
  105.     }
  106.     else if (isset($this->yamlConfig['all'][$keyName]))
  107.     {
  108.       return $this->yamlConfig['all'][$keyName];
  109.     }
  111.     return $defaultValue;
  112.   }
  114.   static public function flattenConfiguration($config)
  115.   {
  116.     $config['all'] = sfToolkit::arrayDeepMerge(
  117.       isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
  118.       isset($config['all']) && is_array($config['all']) ? $config['all'] : array()
  119.     );
  121.     unset($config['default']);
  123.     return $config;
  124.   }
  126.   /**
  127.    * Merges default, all and current environment configurations.
  128.    *
  129.    * @param array $config The main configuratino array
  130.    *
  131.    * @return array The merged configuration
  132.    */
  133.   static public function flattenConfigurationWithEnvironment($config)
  134.   {
  135.     return sfToolkit::arrayDeepMerge(
  136.       isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
  137.       isset($config['all']) && is_array($config['all']) ? $config['all'] : array(),
  138.       isset($config[sfConfig::get('sf_environment')]) && is_array($config[sfConfig::get('sf_environment')]) ? $config[sfConfig::get('sf_environment')] : array()
  139.     );
  140.   }
  141. }
Debug toolbar