symfony API

sfYamlConfigHandler 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.

sfYamlConfigHandler is a base class for YAML (.yml) configuration handlers. This class

Method Summary

  • flattenConfiguration()
  • array flattenConfigurationWithEnvironment($config)
    Merges default, all and current environment configurations.
  • string getConfigValue($keyName, $category, $defaultValue)
    Gets a configuration value for a given key and category.
  • string mergeConfigValue($keyName, $category)
    Merges configuration values for a given key and category.
  • string parseYaml($configFile)
    Parses a YAML (.yml) configuration file.
  • array parseYamls($configFiles)
    Parses an array of YAMLs files and merges them in one configuration array.

Methods inherited from sfConfigHandler

execute , getConfiguration , getParameterHolder , initialize , replaceConstants , replacePath , __construct

Method Details

  • flattenConfiguration () Browse code

  • (array) flattenConfigurationWithEnvironment ($config) Browse code

    $config The main configuratino array

    Merges default, all and current environment configurations.

    returns The merged configuration

  • (string) getConfigValue ($keyName, $category, $defaultValue) Browse code

    $keyName The key name
    $category The category name
    $defaultValue The default value

    Gets a configuration value for a given key and category.

    returns The value associated with this key name and category

  • (string) mergeConfigValue ($keyName, $category) Browse code

    $keyName The key name
    $category The category name

    Merges configuration values for a given key and category.

    returns The value associated with this key name and category

  • (string) parseYaml ($configFile) Browse code

    $configFile An absolute filesystem path to a configuration file

    Parses a YAML (.yml) configuration file.

    returns A parsed .yml configuration

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

  • (array) parseYamls ($configFiles) Browse code

    $configFiles An array of configuration file paths

    Parses an array of YAMLs files and merges them in one configuration array.

    returns A merged configuration array