symfony API

sfSymfonyPluginManager Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

Packages

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

sfSymfonyPluginManager allows you to manage symfony plugins installation and uninstallation.

Inheritence

sfSymfonyPluginManager  <  sfPluginManager

Method Summary

Methods inherited from sfPluginManager

checkDependency , checkPluginDependencies , configure , doInstallPlugin , getEnvironment , getInstalledPlugins , getPluginLicense , getPluginVersion , initialize , installPlugin , isPluginCompatible , isPluginCompatibleWithDependency , uninstallPlugin , __construct

Method Details

  • configure ()

    Configures this plugin manager.

  • disablePlugin ($plugin, $configDir)

    $plugin The name of the plugin
    $configDir The config directory

    Disables a plugin in the ProjectConfiguration class.


    This is a static method that does not rely on the PEAR environment
    as we don't want this method to have PEAR as a dependency.

  • enablePlugin ($plugin, $configDir)

    $plugin The name of the plugin
    $configDir The config directory

    Enables a plugin in the ProjectConfiguration class.


    This is a static method that does not rely on the PEAR environment
    as we don't want this method to have PEAR as a dependency.

  • initialize ($dispatcher, $environment)

    $dispatcher An event dispatcher instance
    $environment A sfPearEnvironment instance

    Initializes this sfPluginManager instance.


    Available options:

    * web_dir: The directory where to plugins assets (images, stylesheets, javascripts, ...)

    See sfPluginManager for other options.

  • installWebContent ($plugin)

    $plugin The plugin name

    Installs web content for a plugin.

  • (Boolean) isPluginCompatibleWithDependency ($dependency)

    $dependency A dependency array

    Returns true if the plugin is comptatible with the dependency.

    returns true if the plugin is compatible, false otherwise

  • listenToPluginPostInstall ($event)

    $event An sfEvent instance

    Listens to the plugin.post_install event.

  • listenToPluginPostUninstall ($event)

    $event An sfEvent instance

    Listens to the plugin.post_uninstall event.

  • registerSymfonyPackage ()

    Registers the symfony package for the current version.

  • uninstallWebContent ($plugin)

    $plugin The plugin name

    Unnstalls web content for a plugin.