123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133 |
- <?php
- /*
- * This file is part of the symfony package.
- * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
- * (c) 2004-2006 Sean Kerr <sean@code-box.org>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- /**
- * 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 <fabien.potencier@symfony-project.com>
- * @author Sean Kerr <sean@code-box.org>
- * @version SVN: $Id: sfConfigHandler.class.php 9398 2008-06-02 00:30:31Z dwhittle $
- */
- abstract class sfConfigHandler
- {
- protected
- $parameterHolder = null;
- /**
- * Class constructor.
- *
- * @see initialize()
- */
- public function __construct($parameters = null)
- {
- $this->initialize($parameters);
- }
- /**
- * Initializes this configuration handler.
- *
- * @param array $parameters An associative array of initialization parameters
- *
- * @return bool true, if initialization completes successfully, otherwise false
- *
- * @throws <b>sfInitializationException</b> If an error occurs while initializing this ConfigHandler
- */
- public function initialize($parameters = null)
- {
- $this->parameterHolder = new sfParameterHolder();
- $this->parameterHolder->add($parameters);
- }
- /**
- * Executes this configuration handler
- *
- * @param array $configFiles An array of filesystem path to a configuration file
- *
- * @return string Data to be written to a cache file
- *
- * @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
- * @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
- */
- abstract public function execute($configFiles);
- /**
- * Replaces constant identifiers in a value.
- *
- * If the value is an array replacements are made recursively.
- *
- * @param mixed $value The value on which to run the replacement procedure
- *
- * @return string The new value
- */
- static public function replaceConstants($value)
- {
- if (is_array($value))
- {
- array_walk_recursive($value, create_function('&$value', '$value = sfToolkit::replaceConstants($value);'));
- }
- else
- {
- $value = sfToolkit::replaceConstants($value);
- }
- return $value;
- }
- /**
- * Replaces a relative filesystem path with an absolute one.
- *
- * @param string $path A relative filesystem path
- *
- * @return string The new path
- */
- static public function replacePath($path)
- {
- if (is_array($path))
- {
- array_walk_recursive($path, create_function('&$path', '$path = sfConfigHandler::replacePath($path);'));
- }
- else
- {
- if (!sfToolkit::isPathAbsolute($path))
- {
- // not an absolute path so we'll prepend to it
- $path = sfConfig::get('sf_app_dir').'/'.$path;
- }
- }
- return $path;
- }
- /**
- * Gets the parameter holder for this configuration handler.
- *
- * @return sfParameterHolder A sfParameterHolder instance
- */
- public function getParameterHolder()
- {
- return $this->parameterHolder;
- }
- /**
- * Returns the configuration for the current config handler.
- *
- * @param array $configFiles An array of ordered configuration files
- * @throws LogicException no matter what
- */
- static public function getConfiguration(array $configFiles)
- {
- throw new LogicException('You must call the ::getConfiguration() method on a concrete config handler class');
- }
- }
|