CRM_Upgrade_DispatchPolicy
in package
Tags
Table of Contents
Methods
- assertActive() : mixed
- Assert that a specific policy is currently active.
- get() : array<string|int, mixed>
- Read the dispatch policy.
- onRunTask() : mixed
- Before running upgrade tasks, ensure that we apply the current dispatch-policy.
- pick() : array<string|int, mixed>
- Determine the dispatch policy
- useTemporarily() : CRM_Utils_AutoClean
- Create an auto-clean object which temporarily applies the preferred policy.
Methods
assertActive()
Assert that a specific policy is currently active.
public
static assertActive(string $name) : mixed
Parameters
- $name : string
-
Ex: 'upgrade.main' or 'upgrade.finish'
Tags
get()
Read the dispatch policy.
public
static get(string $phase) : array<string|int, mixed>
Parameters
- $phase : string
-
Ex: 'upgrade.main' or 'upgrade.finish'.
Tags
Return values
array<string|int, mixed>onRunTask()
Before running upgrade tasks, ensure that we apply the current dispatch-policy.
public
static onRunTask(GenericHookEvent $event) : mixed
Parameters
- $event : GenericHookEvent
pick()
Determine the dispatch policy
public
static pick() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>useTemporarily()
Create an auto-clean object which temporarily applies the preferred policy.
public
static useTemporarily(string $name) : CRM_Utils_AutoClean
Parameters
- $name : string