symfony API

sfApplicationConfiguration Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.2 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.2 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.

sfConfiguration represents a configuration for a symfony application.

Method Summary

  • activate()
  • checkLock()
    Check lock files to see if we're not in a cache cleaning process.
  • checkSymfonyVersion()
    Checks symfony version and clears cache if recent update.
  • configure()
    Configures the current configuration.
  • array filterAutoloadConfig($event, $config)
    Adds enabled plugins to autoload config.
  • string getApplication()
    Returns the application name.
  • getConfigCache()
    Returns a configuration cache object for the current configuration.
  • array getConfigPaths($configPath)
    Gets the configuration file paths for a given relative configuration path.
  • array getControllerDirs($moduleName)
    Gets directories where controller classes are stored for a given module.
  • string getDecoratorDir($template)
    Gets the decorator directory for a given template.
  • array getDecoratorDirs()
    Gets the decorator directories.
  • string getEnvironment()
    Returns the environment name.
  • array getHelperDirs($moduleName = '')
    Gets the helper directories for a given module name.
  • array getI18NDirs($moduleName)
    Gets the i18n directories to use for a given module.
  • array getI18NGlobalDirs()
    Gets the i18n directories to use globally.
  • array getLibDirs($moduleName)
    Gets directories where lib files are stored for a given module.
  • string getTemplateDir($moduleName, $templateFile)
    Gets the template directory to use for a given module and template file.
  • array getTemplateDirs($moduleName)
    Gets directories where template files are stored for a given module.
  • string getTemplatePath($moduleName, $templateFile)
    Gets the template to use for a given module and template file.
  • initConfiguration()
  • initialize()
    Initialized the current configuration.
  • initializePlugins()
    Initializes plugin configuration objects.
  • Boolean isDebug()
    Returns true if this configuration has debug enabled.
  • loadHelpers($helpers, $moduleName = '')
    Loads helpers.
  • loadPluginConfig()
  • setAppDir($appDir)
    Sets the app directory.
  • setCacheDir($cacheDir)
  • setRootDir($rootDir)
    Sets the project root directory.
  • __construct($environment, (Boolean) $debug, $rootDir = null, $dispatcher = null)
    Constructor.

Method Details

  • activate () Browse code

  • checkLock () Browse code

    Check lock files to see if we're not in a cache cleaning process.

  • checkSymfonyVersion () Browse code

    Checks symfony version and clears cache if recent update.

  • configure () Browse code

    Configures the current configuration.


    Override this method if you want to customize your application configuration.

  • (array) filterAutoloadConfig ($event, $config) Browse code

    $event
    $config

    Adds enabled plugins to autoload config.

  • (string) getApplication () Browse code

    Returns the application name.

    returns The application name

  • getConfigCache () Browse code

    Returns a configuration cache object for the current configuration.

    returns A sfConfigCache instance

  • (array) getConfigPaths ($configPath) Browse code

    $configPath The configuration path

    Gets the configuration file paths for a given relative configuration path.

    returns An array of paths

  • (array) getControllerDirs ($moduleName) Browse code

    $moduleName The module name

    Gets directories where controller classes are stored for a given module.

    returns An array of directories

  • (string) getDecoratorDir ($template) Browse code

    $template The template file

    Gets the decorator directory for a given template.

    returns A template directory

  • (array) getDecoratorDirs () Browse code

    Gets the decorator directories.

    returns An array of the decorator directories

  • (string) getEnvironment () Browse code

    Returns the environment name.

    returns The environment name

  • (array) getHelperDirs ($moduleName = '') Browse code

    $moduleName The module name

    Gets the helper directories for a given module name.

    returns An array of directories

  • (array) getI18NDirs ($moduleName) Browse code

    $moduleName The module name

    Gets the i18n directories to use for a given module.

    returns An array of i18n directories

  • (array) getI18NGlobalDirs () Browse code

    Gets the i18n directories to use globally.

    returns An array of i18n directories

  • (array) getLibDirs ($moduleName) Browse code

    $moduleName The module name

    Gets directories where lib files are stored for a given module.

    returns An array of directories

  • (string) getTemplateDir ($moduleName, $templateFile) Browse code

    $moduleName The module name
    $templateFile The template file

    Gets the template directory to use for a given module and template file.

    returns A template directory

  • (array) getTemplateDirs ($moduleName) Browse code

    $moduleName The module name

    Gets directories where template files are stored for a given module.

    returns An array of directories

  • (string) getTemplatePath ($moduleName, $templateFile) Browse code

    $moduleName The module name
    $templateFile The template file

    Gets the template to use for a given module and template file.

    returns A template path

  • initConfiguration () Browse code

  • initialize () Browse code

    Initialized the current configuration.


    Override this method if you want to customize your application initialization.

  • initializePlugins () Browse code

    Initializes plugin configuration objects.

  • (Boolean) isDebug () Browse code

    Returns true if this configuration has debug enabled.

    returns true if the configuration has debug enabled, false otherwise

  • loadHelpers ($helpers, $moduleName = '') Browse code

    $helpers An array of helpers to load
    $moduleName A module name (optional)

    Loads helpers.

  • loadPluginConfig () Browse code

  • setAppDir ($appDir) Browse code

    $appDir The absolute path to the app dir.

    Sets the app directory.

  • setCacheDir ($cacheDir) Browse code

    $cacheDir

  • setRootDir ($rootDir) Browse code

    $rootDir The project root directory

    Sets the project root directory.

  • __construct ($environment, (Boolean) $debug, $rootDir = null, $dispatcher = null) Browse code

    $environment The environment name
    $debug true to enable debug mode
    $rootDir The project root directory
    $dispatcher An event dispatcher

    Constructor.