- Symphony 2.2.4
-
› assets11 -
› boot9 -
› core22 -
› email-gateways3 -
› toolkit67 -
› Unknown33 - Delegates87
- Deprecated30
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
Manager ExtensionManager
public class ExtensionManager extends Manager
class.extensionmanager.php #16The ExtensionManager class is responsible for managing all extensions
in Symphony. Extensions are stored on the file system in the EXTENSIONS
folder. They are autodiscovered where the Extension class name is the same
as it's folder name (excluding the extension prefix).
Methods
void __construct(Administration $parent)
The constructor for ExtensionManager overrides the default Manager
constructor to prevent $this->_Parent from being set.
Parameters
string __getClassName( $name)
Given a name, returns the full class name of an Extension. Extension use an 'extension' prefix.
Parameters
string __getClassPath( $name)
Finds an Extension by name by searching the EXTENSIONS folder and
returns the path to the folder.
Parameters
string __getDriverPath( $name)
Given a name, return the path to the driver of the Extension.
Parameters
See Also
array about( $name)
Returns information about an extension by it's name by calling
it's own about method. This method checks if an extension needs
to be updated or not.
'name' => 'Name of Extension',
'version' => '1.8',
'release-date' => 'YYYY-MM-DD',
'author' => array(
'name' => 'Author Name',
'website' => 'Author Website',
'email' => 'Author Email'
),
'description' => 'A description about this extension'
Parameters
Returns
An associative array describing this extension
See Also
Extension create( $name)
Creates an instance of a given class and returns it
Parameters
boolean disable( $name)
Disabling an extension will prevent it from executing but retain all it's
settings in the relevant tables. Symphony checks that an extension can
be disabled using the canUninstallorDisable() before removing
all delegate subscriptions from the database and calling the extension's
disable() function.
Parameters
See Also
boolean enable( $name)
Enabling an extension will re-register all it's delegates with Symphony. It will also install or update the extension if needs be by calling the extensions respective install and update methods. The enable method is of the extension object is finally called.
Parameters
See Also
integer fetchExtensionID( $name)
A convenience method that returns an extension ID from it's name.
Parameters
string fetchInstalledVersion( $name)
A convenience method that returns an extension version from it's name.
Parameters
integer fetchStatus( $name)
Returns the status of an Extension by name
Parameters
Returns
An extension status, EXTENSION_ENABLED, EXTENSION_DISABLED EXTENSION_NOT_INSTALLED and EXTENSION_REQUIRES_UPDATE. If an extension doesn't exist, null will be returned.
Extension getInstance( $name)
This function returns an instance of an extension from it's name
Parameters
array listAll( $filter)
Will return an associative array of all extensions and their about information
Parameters
Returns
An associative array with the key being the extension folder and the value being the extension's about information
array listInstalledHandles()
Returns an array of all the enabled extensions available
void notifyMembers( $delegate, $page, $context)
Given a delegate name, notify all extensions that have registered to that
delegate to executing their callbacks with a $context array parameter
that contains information about the current Symphony state.
Parameters
integer registerDelegates( $name)
This functions registers an extensions delegates in tbl_extensions_delegates.
Parameters
Returns
The Extension ID
void removeDelegates( $name)
This function will remove all delegate subscriptions for an extension
given an extension's name. This triggers __cleanupDatabase()
Parameters
See Also
integer sortByName( $a, $b)
Custom user sorting function to sort extensions by name
See Also
boolean uninstall( $name)
Uninstalling an extension will unregister all delegate subscriptions and
remove all extension settings. Symphony checks that an extension can
be uninstalled using the canUninstallorDisable() before calling
the extension's uninstall() function.