symfony API

sfPluginConfiguration Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.4 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.4 version. Switch to:

sfPluginConfiguration represents a configuration for a symfony plugin.

Method Summary

  • configure()
    Configures the plugin.
  • connectTests()
    Connects the current plugin's tests to the "test:*" tasks.
  • array filterAutoloadConfig($event, $config)
    Filters sfAutoload configuration values.
  • array filterTestFiles($event, $files)
    Listens for the "task.test.filter_test_files" event and adds tests from the current plugin.
  • string getName()
    Returns the plugin name.
  • string getRootDir()
    Returns the plugin root directory.
  • string guessName()
    Guesses the plugin name.
  • string guessRootDir()
    Guesses the plugin root directory.
  • boolean|null initialize()
    Initializes the plugin.
  • initializeAutoload()
    Initializes autoloading for the plugin.
  • setup()
    Sets up the plugin.
  • __construct($configuration, $rootDir, $name)
    Constructor.

Method Details

  • configure () Browse code

    Configures the plugin.


    This method is called before the plugin's classes have been added to sfAutoload.

  • connectTests () Browse code

    Connects the current plugin's tests to the "test:*" tasks.

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

    Filters sfAutoload configuration values.

  • (array) filterTestFiles ($event, $files) Browse code

    Listens for the "task.test.filter_test_files" event and adds tests from the current plugin.

    returns An array of files with the appropriate tests from the current plugin merged in

  • (string) getName () Browse code

    Returns the plugin name.

  • (string) getRootDir () Browse code

    Returns the plugin root directory.

  • (string) guessName () Browse code

    Guesses the plugin name.

  • (string) guessRootDir () Browse code

    Guesses the plugin root directory.

  • (boolean|null) initialize () Browse code

    Initializes the plugin.


    This method is called after the plugin's classes have been added to sfAutoload.

    returns If false sfApplicationConfiguration will look for a config.php (maintains BC with symfony < 1.2)

  • initializeAutoload () Browse code

    Initializes autoloading for the plugin.


    This method is called when a plugin is initialized in a project
    configuration. Otherwise, autoload is handled in
    {@link sfApplicationConfiguration} using {@link sfAutoload}.

  • setup () Browse code

    Sets up the plugin.


    This method can be used when creating a base plugin configuration class for other plugins to extend.

  • __construct ($configuration, $rootDir, $name) Browse code

    $configuration The project configuration
    $rootDir The plugin root directory
    $name The plugin name

    Constructor.