CRM_Extension_Container_Collection
in package
implements
CRM_Extension_Container_Interface
An extension container is a locally-accessible source tree which can be scanned for extensions.
Table of Contents
Interfaces
- CRM_Extension_Container_Interface
- An extension container is a locally-accessible source tree which can be scanned for extensions.
Properties
- $cache : CRM_Utils_Cache_Interface|null
- $cacheKey : string
- The cache key used for any data stored by this container.
- $containers : array<string|int, mixed>
- Containers.
- $k2c : array<string|int, mixed>
- K2C .... Format is ($key => $containerName).
Methods
- __construct() : mixed
- Class constructor.
- checkRequirements() : array<string|int, mixed>
- Determine if any unmet requirements prevent use of this container.
- getContainer() : CRM_Extension_Container_Interface
- Get the container which defines a particular key.
- getKeys() : array<string|int, mixed>
- Get a list of extensions available in this container.
- getKeysToContainer() : array<string|int, mixed>
- Get a list of all keys in these containers -- and the name of the container which defines each key.
- getPath() : mixed
- Determine the main .php file for an extension
- getResUrl() : mixed
- Determine the base URL for resources provided by the extension.
- refresh() : mixed
- Scan the container for available extensions.
Properties
$cache
public
CRM_Utils_Cache_Interface|null
$cache
Note: Treat as private. This is only public to facilitate debugging.
$cacheKey
The cache key used for any data stored by this container.
public
string
$cacheKey
Note: Treat as private. This is only public to facilitate debugging.
$containers
Containers.
public
array<string|int, mixed>
$containers
Format is [$name => CRM_Extension_Container_Interface]
Note: Treat as private. This is only public to facilitate debugging.
$k2c
K2C .... Format is ($key => $containerName).
public
array<string|int, mixed>
$k2c
Note: Treat as private. This is only public to facilitate debugging.
Methods
__construct()
Class constructor.
public
__construct(array<string|int, mixed> $containers[, CRM_Utils_Cache_Interface|null $cache = NULL ][, string $cacheKey = NULL ]) : mixed
Parameters
- $containers : array<string|int, mixed>
-
Array($name => CRM_Extension_Container_Interface) in order from highest priority (winners) to lowest priority (losers).
- $cache : CRM_Utils_Cache_Interface|null = NULL
-
Cache in which to store extension metadata.
- $cacheKey : string = NULL
-
Unique name for this container.
checkRequirements()
Determine if any unmet requirements prevent use of this container.
public
checkRequirements() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getContainer()
Get the container which defines a particular key.
public
getContainer(string $key) : CRM_Extension_Container_Interface
Parameters
- $key : string
-
Extension name.
Tags
Return values
CRM_Extension_Container_InterfacegetKeys()
Get a list of extensions available in this container.
public
getKeys() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getKeysToContainer()
Get a list of all keys in these containers -- and the name of the container which defines each key.
public
getKeysToContainer() : array<string|int, mixed>
Return values
array<string|int, mixed> —($key => $containerName)
getPath()
Determine the main .php file for an extension
public
getPath(string $key) : mixed
Parameters
- $key : string
Tags
getResUrl()
Determine the base URL for resources provided by the extension.
public
getResUrl(string $key) : mixed
Parameters
- $key : string
Tags
refresh()
Scan the container for available extensions.
public
refresh() : mixed