CRM_Core_Module
in package
A module is any software package that participates in the hook system, such as CiviCRM Module-Extension, a Drupal Module, or a Joomla Plugin.
Tags
Table of Contents
Properties
- $is_active : bool
- Is the module enabled.
- $label : string
- Pretty name of the module
- $name : string
Methods
- __construct() : mixed
- Class constructor.
- collectStatuses() : array<string|int, mixed>
- Get the status for each module.
- getAll() : array<string|int, CRM_Core_Module>
- Get a list of all known modules.
Properties
$is_active
Is the module enabled.
public
bool
$is_active
$label
Pretty name of the module
public
string
$label
$name
public
string
$name
Methods
__construct()
Class constructor.
public
__construct(string $name, bool $is_active[, string|null $label = NULL ]) : mixed
Parameters
- $name : string
-
Unique machine name of the module
- $is_active : bool
- $label : string|null = NULL
-
Pretty name of the module. If omitted, fallback to $name.
collectStatuses()
Get the status for each module.
public
static collectStatuses(array<string|int, mixed> $modules) : array<string|int, mixed>
Parameters
- $modules : array<string|int, mixed>
-
Array(CRM_Core_Module).
Tags
Return values
array<string|int, mixed> —Array(string $moduleName => string $statusCode).
getAll()
Get a list of all known modules.
public
static getAll([bool $fresh = FALSE ]) : array<string|int, CRM_Core_Module>
Parameters
- $fresh : bool = FALSE
-
Force new results?