symfony API

sfConfigHandler Class

« Back to API menu

1.0 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.0 version. Switch to:

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.

Inheritence

sfYamlConfigHandler  <  sfConfigHandler

Method Summary

  • string execute($configFiles)
    Executes this configuration handler
  • bool initialize($parameters = null)
    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.
  • getParameterHolder()
    Gets the parameter holder for this configuration handler.

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

  • (bool) initialize ($parameters = null) 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

  • getParameterHolder () Browse code

    Gets the parameter holder for this configuration handler.

    returns A sfParameterHolder instance

The Sensio Labs Network

Since 1998, Sensio Labs has been promoting the Open-Source software movement by providing quality web application development, training, consulting, and supporting several large Open-Source projects.

Open-Source Software

Services

> More