symfony API

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

sfProjectConfiguration represents a configuration for a symfony project.

Method Summary

  • sfProjectConfiguration getActive()
    Returns the active configuration.
  • sfApplicationConfiguration getApplicationConfiguration($application, $environment, $debug, $rootDir, $dispatcher)
    Returns a sfApplicationConfiguration configuration for a given application.
  • sfEventDispatcher getEventDispatcher()
    Returns the event dispatcher.
  • array getGeneratorSkeletonDirs($class, $theme)
    Gets directories where the skeleton is stored for a generator class and a specific theme.
  • string getGeneratorTemplate($class, $theme, $path)
    Gets the template to use for a generator class.
  • array getGeneratorTemplateDirs($class, $theme)
    Gets directories where template files are stored for a generator class and a specific theme.
  • array getModelDirs()
    Gets directories where model classes are stored. The order of returned paths is lowest precedence
  • array getPluginPaths()
    Gets the paths to plugins root directories, minding overloaded plugins.
  • string getRootDir()
    Returns the project root directory.
  • string getSymfonyLibDir()
    Returns the symfony lib directory.
  • guessRootDir()
  • setCacheDir($cacheDir)
    Sets the cache root directory.
  • setLogDir($logDir)
    Sets the log directory.
  • setRootDir($rootDir)
    Sets the project root directory.
  • setup()
    Setups the current configuration.
  • setWebDir($webDir)
    Sets the web root directory.
  • mixed __call($method, $arguments)
    Calls methods defined via sfEventDispatcher.
  • __construct($rootDir, $dispatcher)
    Constructor.

Method Details

  • (sfProjectConfiguration) getActive () Browse code

    Returns the active configuration.

    returns The current sfProjectConfiguration instance

  • (sfApplicationConfiguration) getApplicationConfiguration ($application, $environment, $debug, $rootDir, $dispatcher) Browse code

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

    Returns a sfApplicationConfiguration configuration for a given application.

    returns A sfApplicationConfiguration instance

  • (sfEventDispatcher) getEventDispatcher () Browse code

    Returns the event dispatcher.

    returns A sfEventDispatcher instance

  • (array) getGeneratorSkeletonDirs ($class, $theme) Browse code

    $class The generator class name
    $theme The theme name

    Gets directories where the skeleton is stored for a generator class and a specific theme.

    returns An array of directories

  • (string) getGeneratorTemplate ($class, $theme, $path) Browse code

    $class The generator class name
    $theme The theme name
    $path The template path

    Gets the template to use for a generator class.

    returns A template path

    throws sfException

  • (array) getGeneratorTemplateDirs ($class, $theme) Browse code

    $class The generator class name
    $theme The theme name

    Gets directories where template files are stored for a generator class and a specific theme.

    returns An array of directories

  • (array) getModelDirs () Browse code

    Gets directories where model classes are stored. The order of returned paths is lowest precedence

    to highest precedence.

    returns An array of directories

  • (array) getPluginPaths () Browse code

    Gets the paths to plugins root directories, minding overloaded plugins.

    returns The plugin root paths.

  • (string) getRootDir () Browse code

    Returns the project root directory.

    returns The project root directory

  • (string) getSymfonyLibDir () Browse code

    Returns the symfony lib directory.

    returns The symfony lib directory

  • guessRootDir () Browse code

  • setCacheDir ($cacheDir) Browse code

    $cacheDir The absolute path to the cache dir.

    Sets the cache root directory.

  • setLogDir ($logDir) Browse code

    $logDir The absolute path to the log dir.

    Sets the log directory.

  • setRootDir ($rootDir) Browse code

    $rootDir The project root directory

    Sets the project root directory.

  • setup () Browse code

    Setups the current configuration.


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

  • setWebDir ($webDir) Browse code

    $webDir The absolute path to the web dir.

    Sets the web root directory.

  • (mixed) __call ($method, $arguments) Browse code

    $method The method name
    $arguments The method arguments

    Calls methods defined via sfEventDispatcher.

    returns The returned value of the called method

  • __construct ($rootDir, $dispatcher) Browse code

    $rootDir The project root directory
    $dispatcher The event dispatcher

    Constructor.