Documentation

CRM_Extension_Manager
in package

CRM

The extension manager handles installing, disabling enabling, and uninstalling extensions.

You should obtain a singleton of this class via

$manager = CRM_Extension_System::singleton()->getManager();

Constants

STATUS_DISABLED = 'disabled': The extension config has been applied to database but deactivated.
STATUS_DISABLED_MISSING = 'disabled-missing': The extension was installed and is now disabled; the code is not accessible
STATUS_INSTALLED = 'installed': The extension is fully installed and enabled.
STATUS_INSTALLED_MISSING = 'installed-missing': The extension is installed but the code is not accessible
STATUS_UNINSTALLED = 'uninstalled': The extension code is visible, but nothing has been applied to DB
STATUS_UNKNOWN = 'unknown': The extension code is not locally accessible

Properties

$defaultContainer : CRM_Extension_Container_Basic|false: Default container.
$fullContainer : CRM_Extension_Container_Interface
$mapper : CRM_Extension_Mapper: Mapper.
$statuses : array<string|int, mixed>: Statuses.
$typeManagers : array<string|int, mixed>: Type managers.
$processes : array<string|int, mixed>: Live process(es) per extension.

Methods

__construct() : mixed: Class constructor.
createInfoFromDB() : CRM_Extension_Info|null: Auto-generate a place-holder for a missing extension using info from database.
disable() : mixed: Disable extension without removing record from db.
enable() : mixed: Add records of the extension to the database -- and enable it
extensionIsBeingInstalledOrEnabled() : bool: Determine if the extension specified is currently involved in an install or enable process. Just sugar code to make things more readable.
findDisableRequirements() : array<string|int, mixed>: Build a list of extensions to remove, in an order that will satisfy dependencies.
findInstallRequirements() : array<string|int, mixed>: Build a list of extensions to install, in an order that will satisfy dependencies.
getActiveProcesses() : array<string|int, mixed>: Return current processes for given extension.
getStatus() : string: Determine the status of an extension.
getStatuses() : array<string|int, mixed>: Determine the status of all extensions.
install() : mixed: Add records of the extension to the database -- and enable it
isEnabled() : bool: Check if a given extension is installed and enabled
isIncompatible() : bool|array<string|int, mixed>: Check if a given extension is incompatible with this version of CiviCRM
refresh() : mixed
replace() : mixed: Install or upgrade the code for an extension -- and perform any necessary database changes (eg replacing extension metadata).
setProcessesForTesting() : mixed: Provides way to set processes property for phpunit tests - not for general use.
uninstall() : mixed: Remove all database references to an extension.
addProcess() : mixed: Add a process to the stacks for the extensions.
filterInfosByStatus() : array<string|int, mixed>
popProcess() : mixed: Pop the top op from the stacks for the extensions.
_createExtensionEntry() : bool
_getInfoTypeHandler() : array<string|int, mixed>: Find the $info and $typeManager for a $key
_getMissingInfoTypeHandler() : array<string|int, mixed>: Find the $info and $typeManager for a $key
_removeExtensionEntry() : mixed
_setExtensionActive() : mixed
_updateExtensionEntry() : bool

STATUS_DISABLED

The extension config has been applied to database but deactivated.


    public
        mixed
    STATUS_DISABLED
    = 'disabled'

STATUS_DISABLED_MISSING

The extension was installed and is now disabled; the code is not accessible


    public
        mixed
    STATUS_DISABLED_MISSING
    = 'disabled-missing'

STATUS_INSTALLED

The extension is fully installed and enabled.


    public
        mixed
    STATUS_INSTALLED
    = 'installed'

STATUS_INSTALLED_MISSING

The extension is installed but the code is not accessible


    public
        mixed
    STATUS_INSTALLED_MISSING
    = 'installed-missing'

STATUS_UNINSTALLED

The extension code is visible, but nothing has been applied to DB


    public
        mixed
    STATUS_UNINSTALLED
    = 'uninstalled'

STATUS_UNKNOWN

The extension code is not locally accessible


    public
        mixed
    STATUS_UNKNOWN
    = 'unknown'