sfPluginManager allows you to manage plugins installation and
uninstallation.
Method Summary
-
Boolean
checkDependency($dependency)
Checks that the dependency is valid.
-
checkPluginDependencies($plugin, $version, $options = false)
Checks all plugin dependencies.
-
configure()
Configures this plugin manager.
-
doInstallPlugin($plugin, $options = array())
Installs a plugin
-
getEnvironment()
Returns the sfPearEnvironment instance.
-
array
getInstalledPlugins()
Returns a list of installed plugin.
-
string
getPluginLicense($plugin, $options = array())
Returns the license for a given plugin.
-
string
getPluginVersion($plugin, $stability = null)
Gets the "best" version available for a given plugin.
-
initialize($dispatcher, $environment)
Initializes this sfPluginManager instance.
-
installPlugin($plugin, $options = array())
Installs a plugin.
-
Boolean
isPluginCompatible($plugin, $version)
Returns true if the plugin is comptatible with your environment.
-
Boolean
isPluginCompatibleWithDependency($dependency)
Returns true if the plugin is comptatible with the dependency.
-
uninstallPlugin($plugin, $channel = null)
Uninstalls a plugin.
-
__construct($dispatcher, $environment)
Constructs a new sfPluginManager.
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)
-
Configures this plugin manager.
-
doInstallPlugin ($plugin, $options = array())
Browse code
Installs a plugin
-
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 "best" 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.
|