symfony API

sfConfigHandler Class

« Back to API menu

action

addon

cache

config

controller

countable

database

debug

exception

filter

generator

helper

i18n

log

request

response

storage

test

user

util

validator

view

You are currently browsing the symfony documentation 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)

    $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)

    $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)

    $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)

    $path A relative filesystem path

    Replaces a relative filesystem path with an absolute one.

    returns The new path

  • getParameterHolder ()

    Gets the parameter holder for this configuration handler.

    returns A sfParameterHolder instance