CRM_Extension_Upgrades
in package
This class stores logic for managing schema upgrades in CiviCRM extensions.
Tags
Table of Contents
Constants
- QUEUE_NAME = 'ext-upgrade'
Methods
- createQueue() : CRM_Queue_Queue
- Fill a queue with upgrade tasks.
- fillQueue() : CRM_Queue_Queue
- hasPending() : bool
- Determine whether any extensions have pending upgrades.
- upgradeLogTables() : mixed
- Update log tables following execution of extension upgrades
- getActiveKeys() : array<string|int, string>
- getActiveUpgraders() : array<string|int, mixed>
- sortKeys() : array<string|int, string>
- Sorts active extensions according to their dependencies
Constants
QUEUE_NAME
public
mixed
QUEUE_NAME
= 'ext-upgrade'
Methods
createQueue()
Fill a queue with upgrade tasks.
public
static createQueue() : CRM_Queue_Queue
Return values
CRM_Queue_QueuefillQueue()
public
static fillQueue(CRM_Queue_Queue $queue) : CRM_Queue_Queue
Parameters
- $queue : CRM_Queue_Queue
Return values
CRM_Queue_QueuehasPending()
Determine whether any extensions have pending upgrades.
public
static hasPending() : bool
Return values
boolupgradeLogTables()
Update log tables following execution of extension upgrades
public
static upgradeLogTables() : mixed
getActiveKeys()
protected
static getActiveKeys() : array<string|int, string>
Return values
array<string|int, string>getActiveUpgraders()
protected
static getActiveUpgraders() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array(string $extKey => CRM_Extension_Upgrader_Interface $upgrader)
sortKeys()
Sorts active extensions according to their dependencies
protected
static sortKeys(array<string|int, string> $keys) : array<string|int, string>
Parameters
- $keys : array<string|int, string>
-
Names of all active modules