CheckRequirementsEvent
extends BaseSetupEvent
in package
Check if the local system meets the installation requirements.
Event Name: 'civi.setup.checkRequirements'
Table of Contents
Properties
- $hookFields : array<string|int, mixed>
- $hookFieldsFlip : array<string|int, mixed>
- $hookValues : array<string|int, mixed>
- $messages : mixed
- $model : Model
- $BLACKLIST : array<string|int, mixed>
- List of field names that are prohibited due to conflicts in the class-hierarchy.
- $returnValues : mixed
- Some legacy hooks expect listener-functions to return a value.
Methods
- __construct() : mixed
- BaseSetupEvent constructor.
- __get() : mixed
- __isset() : mixed
- __set() : mixed
- __unset() : mixed
- addError() : mixed
- addInfo() : mixed
- addMessage() : $this
- addReturnValues() : GenericHookEvent
- addWarning() : mixed
- create() : GenericHookEvent
- Create a GenericHookEvent using key-value pairs.
- createOrdered() : GenericHookEvent
- Create a GenericHookEvent using ordered parameters.
- getErrors() : mixed
- getHookValues() : array<string|int, mixed>
- getInfos() : mixed
- getMessages() : array<string|int, mixed>
- getModel() : Model
- getReturnValues() : mixed
- getWarnings() : mixed
- hasField() : bool
- Determine whether the hook supports the given field.
- setModel() : mixed
- assertValidHookFields() : mixed
Properties
$hookFields
protected
array<string|int, mixed>
$hookFields
Ex: array(0 => 'contactID', 1 => 'contentPlacement').
$hookFieldsFlip
protected
array<string|int, mixed>
$hookFieldsFlip
Ex: array('contactID' => 0, 'contentPlacement' => 1).
$hookValues
protected
array<string|int, mixed>
$hookValues
Ex: array(0 => &$contactID, 1 => &$contentPlacement).
$messages
protected
mixed
$messages
$model
protected
Model
$model
$BLACKLIST
List of field names that are prohibited due to conflicts in the class-hierarchy.
private
static array<string|int, mixed>
$BLACKLIST
= ['name', 'dispatcher', 'propagationStopped', 'hookBlacklist', 'hookValues', 'hookFields', 'hookFieldsFlip']
$returnValues
Some legacy hooks expect listener-functions to return a value.
private
mixed
$returnValues
= []
OOP listeners may set the $returnValue.
This field is not recommended for use in new hooks. The return-value convention is not portable across different implementations of the hook system. Instead, it's more portable to provide an alterable, named field.
Methods
__construct()
BaseSetupEvent constructor.
public
__construct(Model $model) : mixed
Parameters
- $model : Model
__get()
public
& __get(mixed $name) : mixed
Parameters
- $name : mixed
Tags
__isset()
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
Tags
__set()
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Tags
__unset()
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
Tags
addError()
public
addError(mixed $section, mixed $name[, mixed $message = '' ]) : mixed
Parameters
- $section : mixed
- $name : mixed
- $message : mixed = ''
addInfo()
public
addInfo(mixed $section, mixed $name[, mixed $message = '' ]) : mixed
Parameters
- $section : mixed
- $name : mixed
- $message : mixed = ''
addMessage()
public
addMessage(string $severity, string $section, string $name, string $message) : $this
Parameters
- $severity : string
-
Severity/level. Ex: 'info', 'warning', 'error'.
- $section : string
-
Symbolic machine name for this group of messages. Ex: 'database' or 'system'.
- $name : string
-
Symbolic machine name for this particular message. Ex: 'mysqlThreadstack'
- $message : string
-
Displayable explanation. Ex: 'The MySQL thread stack is too small.'
Return values
$thisaddReturnValues()
public
addReturnValues(mixed $fResult) : GenericHookEvent
Parameters
- $fResult : mixed
Return values
GenericHookEventaddWarning()
public
addWarning(mixed $section, mixed $name[, mixed $message = '' ]) : mixed
Parameters
- $section : mixed
- $name : mixed
- $message : mixed = ''
create()
Create a GenericHookEvent using key-value pairs.
public
static create(array<string|int, mixed> $params) : GenericHookEvent
Parameters
- $params : array<string|int, mixed>
-
Ex: array('contactID' => &$contactID, 'contentPlacement' => &$contentPlacement).
Return values
GenericHookEventcreateOrdered()
Create a GenericHookEvent using ordered parameters.
public
static createOrdered(array<string|int, mixed> $hookFields, array<string|int, mixed> $hookValues) : GenericHookEvent
Parameters
- $hookFields : array<string|int, mixed>
-
Ex: array(0 => 'contactID', 1 => 'contentPlacement').
- $hookValues : array<string|int, mixed>
-
Ex: array(0 => &$contactID, 1 => &$contentPlacement).
Return values
GenericHookEventgetErrors()
public
getErrors() : mixed
getHookValues()
public
getHookValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —Ex: array(0 => &$contactID, 1 => &$contentPlacement).
getInfos()
public
getInfos() : mixed
getMessages()
public
getMessages([string|null $severity = NULL ]) : array<string|int, mixed>
Parameters
- $severity : string|null = NULL
-
Filter by severity of the message. Ex: 'info', 'error', 'warning'.
Return values
array<string|int, mixed> —List of messages. Each has fields:
- name: string, symbolic name.
- message: string, displayable message.
- severity: string, ex: 'info', 'warning', 'error'.
getModel()
public
getModel() : Model
Return values
ModelgetReturnValues()
public
getReturnValues() : mixed
getWarnings()
public
getWarnings() : mixed
hasField()
Determine whether the hook supports the given field.
public
hasField(string $name) : bool
The field may or may not be empty. Use isset() or empty() to check that.
Parameters
- $name : string
Return values
boolsetModel()
public
setModel(Model $model) : mixed
Parameters
- $model : Model
assertValidHookFields()
private
static assertValidHookFields(array<string|int, mixed> $fields) : mixed
Parameters
- $fields : array<string|int, mixed>
-
List of field names.