CRM_Extension_Container_Collection

class CRM_Extension_Container_Collection implements CRM_Extension_Container_Interface

An extension container is a locally-accessible source tree which can be scanned for extensions.

Properties

array $containers Containers.
CRM_Utils_Cache_Interface|null $cache
string $cacheKey The cache key used for any data stored by this container.
array $k2c K2C .

Methods

__construct(array $containers, CRM_Utils_Cache_Interface $cache = NULL, string $cacheKey = NULL)

Class constructor.

checkRequirements()

No description

getKeys()

No description

getPath(string $key)

No description

getResUrl(string $key)

No description

refresh()

No description

CRM_Extension_Container_Interface
getContainer(string $key)

Get the container which defines a particular key.

array
getKeysToContainer()

Get a list of all keys in these containers -- and the name of the container which defines each key.

Details

at line 88
__construct(array $containers, CRM_Utils_Cache_Interface $cache = NULL, string $cacheKey = NULL)

Class constructor.

Parameters

array $containers Array($name => CRM_Extension_Container_Interface) in order from highest priority (winners) to lowest priority (losers).
CRM_Utils_Cache_Interface $cache Cache in which to store extension metadata.
string $cacheKey Unique name for this container.

at line 99
checkRequirements()

at line 112
getKeys()

at line 124
getPath(string $key)

Parameters

string $key Fully-qualified extension name.

Exceptions

CRM_Extension_Exception_MissingException

at line 135
getResUrl(string $key)

Parameters

string $key Fully-qualified extension name.

Exceptions

CRM_Extension_Exception_MissingException

at line 142
refresh()

at line 160
CRM_Extension_Container_Interface getContainer(string $key)

Get the container which defines a particular key.

Parameters

string $key Extension name.

Return Value

CRM_Extension_Container_Interface

Exceptions

CRM_Extension_Exception_MissingException

at line 177
array getKeysToContainer()

Get a list of all keys in these containers -- and the name of the container which defines each key.

Return Value

array ($key => $containerName)