symfony API

sfConfigHandler Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.1 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.1 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfConfigHandler allows a developer to create a custom formatted configuration

Inheritence

sfYamlConfigHandler  <  sfConfigHandler

Method Summary

  • string execute($configFiles)
    Executes this configuration handler
  • getConfiguration($configFiles)
    Returns the configuration for the current config handler.
  • sfParameterHolder getParameterHolder()
    Gets the parameter holder for this configuration handler.
  • bool initialize($parameters)
    Initializes this configuration handler.
  • string replaceConstants($value)
    Replaces constant identifiers in a value.
  • string replacePath($path)
    Replaces a relative filesystem path with an absolute one.
  • __construct()
    Class constructor.

Method Details

  • (string) execute ($configFiles) Browse code

    $configFiles An array of filesystem path to a configuration file

    Executes this configuration handler

    returns Data to be written to a cache file

    throws sfConfigurationException If a requested configuration file does not exist or is not readable

  • getConfiguration ($configFiles) Browse code

    $configFiles An array of ordered configuration files

    Returns the configuration for the current config handler.

    throws LogicException no matter what

  • (sfParameterHolder) getParameterHolder () Browse code

    Gets the parameter holder for this configuration handler.

    returns A sfParameterHolder instance

  • (bool) initialize ($parameters) Browse code

    $parameters An associative array of initialization parameters

    Initializes this configuration handler.

    returns true, if initialization completes successfully, otherwise false

    throws sfInitializationException If an error occurs while initializing this ConfigHandler

  • (string) replaceConstants ($value) Browse code

    $value The value on which to run the replacement procedure

    Replaces constant identifiers in a value.


    If the value is an array replacements are made recursively.

    returns The new value

  • (string) replacePath ($path) Browse code

    $path A relative filesystem path

    Replaces a relative filesystem path with an absolute one.

    returns The new path

  • __construct () Browse code

    Class constructor.