symfony API

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

sfPluginManager allows you to manage plugins installation and uninstallation.

Inheritence

sfSymfonyPluginManager  <  sfPluginManager

Method Summary

Method Details

  • (Boolean) checkDependency ($dependency) Browse code

    $dependency A dependency array

    Checks that the dependency is valid.

    returns true if the dependency is valid, false otherwise

  • checkPluginDependencies ($plugin, $version, $options = false) Browse code

    $plugin The plugin name
    $version The plugin version
    $options An array of options

    Checks all plugin dependencies.


    Available options:

    * stability: The stability preference
    * install_deps: Whether to automatically install dependencies (default to false)

  • configure () Browse code

    Configures this plugin manager.

  • doInstallPlugin ($plugin, $options = array()) Browse code

    $plugin
    $options

    Installs a plugin

  • getEnvironment () Browse code

    Returns the sfPearEnvironment instance.

    returns The sfPearEnvironment instance

  • (array) getInstalledPlugins () Browse code

    Returns a list of installed plugin.

    returns An array of installed plugins

  • (string) getPluginLicense ($plugin, $options = array()) Browse code

    $plugin The plugin name
    $options An array of options

    Returns the license for a given plugin.

    returns The license

  • (string) getPluginVersion ($plugin, $stability = null) Browse code

    $plugin The plugin name
    $stability The stability name

    Gets the &quot;best&quot; version available for a given plugin.

    returns The version

  • initialize ($dispatcher, $environment) Browse code

    $dispatcher An event dispatcher instance
    $environment A sfPearEnvironment instance

    Initializes this sfPluginManager instance.


    see sfPearEnvironment for available options.

  • installPlugin ($plugin, $options = array()) Browse code

    $plugin The plugin name
    $options An array of options

    Installs a plugin.


    If you don't pass a version, it will install the latest version available for the current project symfony version.

    Available options:

    * channel: The plugin channel name
    * version: The version to install
    * stability: The stability preference
    * install_deps: Whether to automatically install dependencies (default to false)

  • (Boolean) isPluginCompatible ($plugin, $version) Browse code

    $plugin The plugin name
    $version The plugin version

    Returns true if the plugin is comptatible with your environment.

    returns true if the plugin is compatible, false otherwise

  • (Boolean) isPluginCompatibleWithDependency ($dependency) Browse code

    $dependency An dependency array

    Returns true if the plugin is comptatible with the dependency.

    returns true if the plugin is compatible, false otherwise

  • uninstallPlugin ($plugin, $channel = null) Browse code

    $plugin The plugin name
    $channel The channel name

    Uninstalls a plugin.

  • __construct ($dispatcher, $environment) Browse code

    $dispatcher An event dispatcher instance
    $environment A sfPearEnvironment instance

    Constructs a new sfPluginManager.