symfony API

sfProjectConfiguration Class

« Back to API menu

action

addon

autoload

cache

command

config

controller

creole

database

debug

exception

filter

form

generator

helper

i18n

log

plugin

propel

request

response

routing

storage

task

test

user

util

validator

view

widget

You are currently browsing the symfony documentation for the 1.1 version. Switch to:

sfProjectConfiguration represents a configuration for a symfony project.

Method Summary

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

Method Details

  • __construct ($rootDir = null, $dispatcher = null)

    $rootDir The project root directory
    $dispatcher The event dispatcher

    Constructor.

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

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

    Returns the project root directory.

    returns The project root directory

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

    $method The method name
    $arguments The method arguments

    Calls methods defined via sfEventDispatcher.

    returns The returned value of the called method

  • (array) getPluginPaths ()

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

    returns The plugin root paths.

  • getApplicationConfiguration ($application, $environment, (Boolean) $debug, $rootDir = null, $dispatcher = null)

    $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

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

    $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

  • (string) getSymfonyLibDir ()

    Returns the symfony lib directory.

    returns The symfony lib directory

  • setRootDir ($rootDir)

    $rootDir The project root directory

    Sets the project root directory.

  • setWebDir ($webDir)

    $webDir The absolute path to the web dir.

    Sets the web root directory.

  • setLogDir ($logDir)

    $logDir The absolute path to the log dir.

    Sets the log directory.

  • setup ()

    Setups the current configuration.

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

  • getEventDispatcher ()

    Returns the event dispatcher.

    returns A sfEventDispatcher instance

  • (array) getModelDirs ()

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

    returns An array of directories

  • getActive ()

    Returns the active configuration.

    returns The current sfProjectConfiguration instance

  • setCacheDir ($cacheDir)

    $cacheDir The absolute path to the cache dir.

    Sets the cache root directory.

  • guessRootDir ()

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

    $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