symfony API

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

sfYamlConfigHandler is a base class for YAML (.yml) configuration handlers. This class provides a central location for parsing YAML files and detecting required categories.

Method Summary

  • 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.
  • string getConfigValue($keyName, $category, $defaultValue = null)
    Gets a configuration value for a given key and category.
  • string mergeConfigValue($keyName, $category)
    Merges configuration values for a given key and category.

Methods inherited from sfConfigHandler

execute , initialize , replaceConstants , replacePath , getParameterHolder

Method Details

  • (string) parseYaml ($configFile)

    $configFile An absolute filesystem path to a configuration file

    Parses a YAML (.yml) configuration file.

    returns A parsed .yml configuration

    throws sfParseException If a requested configuration file is improperly formatted

  • (array) parseYamls ($configFiles)

    $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

  • (string) getConfigValue ($keyName, $category, $defaultValue = null)

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

    $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