1. sfConfigHandler.class.php
  2. /**
 * sfConfigHandler allows a developer to create a custom formatted configuration
 * file pertaining to any information they like and still have it auto-generate
 * PHP code.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfConfigHandler
  4. {
  5.   protected
  6.     $parameterHolder = null;
  8.   /**
  9.    * Class constructor.
  10.    *
  11.    * @see initialize()
  12.    */
  13.   public function __construct($parameters = null)
  14.   {
  15.     $this->initialize($parameters);
  16.   }
  18.   /**
  19.    * Initializes this configuration handler.
  20.    *
  21.    * @param array $parameters An associative array of initialization parameters
  22.    *
  23.    * @return bool true, if initialization completes successfully, otherwise false
  24.    *
  25.    * @throws <b>sfInitializationException</b> If an error occurs while initializing this ConfigHandler
  26.    */
  27.   public function initialize($parameters = null)
  28.   {
  29.     $this->parameterHolder = new sfParameterHolder();
  30.     $this->parameterHolder->add($parameters);
  31.   }
  33.   /**
  34.    * Executes this configuration handler
  35.    *
  36.    * @param array $configFiles An array of filesystem path to a configuration file
  37.    *
  38.    * @return string Data to be written to a cache file
  39.    *
  40.    * @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
  41.    * @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
  42.    */
  43.   abstract public function execute($configFiles);
  45.   /**
  46.    * Replaces constant identifiers in a value.
  47.    *
  48.    * If the value is an array replacements are made recursively.
  49.    *
  50.    * @param mixed $value The value on which to run the replacement procedure
  51.    *
  52.    * @return string The new value
  53.    */
  54.   static public function replaceConstants($value)
  55.   {
  56.     if (is_array($value))
  57.     {
  58.       array_walk_recursive($value, create_function('&$value', '$value = sfToolkit::replaceConstants($value);'));
  59.     }
  60.     else
  61.     {
  62.       $value = sfToolkit::replaceConstants($value);
  63.     }
  65.     return $value;
  66.   }
  68.   /**
  69.    * Replaces a relative filesystem path with an absolute one.
  70.    *
  71.    * @param string $path A relative filesystem path
  72.    *
  73.    * @return string The new path
  74.    */
  75.   static public function replacePath($path)
  76.   {
  77.     if (is_array($path))
  78.     {
  79.       array_walk_recursive($path, create_function('&$path', '$path = sfConfigHandler::replacePath($path);'));
  80.     }
  81.     else
  82.     {
  83.       if (!sfToolkit::isPathAbsolute($path))
  84.       {
  85.         // not an absolute path so we'll prepend to it
  86.         $path = sfConfig::get('sf_app_dir').'/'.$path;
  87.       }
  88.     }
  90.     return $path;
  91.   }
  93.   /**
  94.    * Gets the parameter holder for this configuration handler.
  95.    *
  96.    * @return sfParameterHolder A sfParameterHolder instance
  97.    */
  98.   public function getParameterHolder()
  99.   {
  100.     return $this->parameterHolder;
  101.   }
  103.   /**
  104.    * Returns the configuration for the current config handler.
  105.    *
  106.    * @param array $configFiles An array of ordered configuration files
  107.    * @throws LogicException no matter what
  108.    */
  109.   static public function getConfiguration(array $configFiles)
  110.   {
  111.     throw new LogicException('You must call the ::getConfiguration() method on a concrete config handler class');
  112.   }
  113. }
Debug toolbar