CRM_Extension_Manager
class CRM_Extension_Manager
The extension manager handles installing, disabling enabling, and uninstalling extensions.
Constants
| STATUS_INSTALLED |
The extension is fully installed and enabled. |
| STATUS_DISABLED |
The extension config has been applied to database but deactivated. |
| STATUS_UNINSTALLED |
The extension code is visible, but nothing has been applied to DB |
| STATUS_UNKNOWN |
The extension code is not locally accessible |
| STATUS_INSTALLED_MISSING |
The extension is installed but the code is not accessible |
| STATUS_DISABLED_MISSING |
The extension was installed and is now disabled; the code is not accessible |
Properties
| CRM_Extension_Container_Interface | $fullContainer | ||
| CRM_Extension_Container_Basic|false | $defaultContainer | Default container. | |
| CRM_Extension_Mapper | $mapper | Mapper. | |
| array | $typeManagers | Type managers. | |
| array | $statuses | Statuses. |
Methods
Class constructor.
Install or upgrade the code for an extension -- and perform any necessary database changes (eg replacing extension metadata).
Add records of the extension to the database -- and enable it
Add records of the extension to the database -- and enable it
Disable extension without removing record from db.
Remove all database references to an extension.
Determine the status of an extension.
Check if a given extension is incompatible with this version of CiviCRM
Determine the status of all extensions.
No description
Auto-generate a place-holder for a missing extension using info from database.
Build a list of extensions to install, in an order that will satisfy dependencies.
Build a list of extensions to remove, in an order that will satisfy dependencies.
No description
Details
at line 121
__construct(CRM_Extension_Container_Interface $fullContainer, CRM_Extension_Container_Basic|FALSE $defaultContainer, CRM_Extension_Mapper $mapper, array $typeManagers)
Class constructor.
at line 138
replace(string $tmpCodeDir)
Install or upgrade the code for an extension -- and perform any necessary database changes (eg replacing extension metadata).
This only works if the extension is stored in the default container.
at line 222
install(string|array $keys)
Add records of the extension to the database -- and enable it
at line 319
enable(array $keys)
Add records of the extension to the database -- and enable it
at line 330
disable(string|array $keys)
Disable extension without removing record from db.
at line 387
uninstall(string|array $keys)
Remove all database references to an extension.
at line 439
string
getStatus($key)
Determine the status of an extension.
at line 455
bool|array
isIncompatible($key)
Check if a given extension is incompatible with this version of CiviCRM
at line 466
array
getStatuses()
Determine the status of all extensions.
at line 503
refresh()
at line 630
CRM_Extension_Info|NULL
createInfoFromDB($key)
Auto-generate a place-holder for a missing extension using info from database.
at line 656
array
findInstallRequirements(array $keys, CRM_Extension_Info $info = NULL)
Build a list of extensions to install, in an order that will satisfy dependencies.
at line 699
array
findDisableRequirements(array $keys)
Build a list of extensions to remove, in an order that will satisfy dependencies.