CRM_Extension_Container_Default

class CRM_Extension_Container_Default extends CRM_Extension_Container_Basic

The default container is just a basic container which can be configured via the web UI.

Properties

string $baseDir from CRM_Extension_Container_Basic
string $baseUrl from CRM_Extension_Container_Basic
CRM_Utils_Cache_Interface|NULL $cache from CRM_Extension_Container_Basic
string $cacheKey from CRM_Extension_Container_Basic
array($key $relPaths from CRM_Extension_Container_Basic
array($key $relUrls from CRM_Extension_Container_Basic
protected array $filters from CRM_Extension_Container_Basic

Methods

__construct(string $baseDir, string $baseUrl, CRM_Utils_Cache_Interface $cache = NULL, string $cacheKey = NULL)

No description

from CRM_Extension_Container_Basic
checkRequirements()

No description

getKeys()

No description

from CRM_Extension_Container_Basic
getPath(string $key)

No description

from CRM_Extension_Container_Basic
getResUrl(string $key)

No description

from CRM_Extension_Container_Basic
refresh()

No description

from CRM_Extension_Container_Basic
string
getBaseDir()

No description

from CRM_Extension_Container_Basic
string
getRelPath(string $key)

Determine the relative path of an extension directory.

from CRM_Extension_Container_Basic
array
getRelPaths()

Scan $basedir for a list of extension-keys

from CRM_Extension_Container_Basic
string
getRelUrl(string $key)

Determine the relative path of an extension directory.

from CRM_Extension_Container_Basic
array
getRelUrls()

Scan $basedir for a list of extension-keys

from CRM_Extension_Container_Basic
$this
addFilter(callable $callable)

Register a filter which determine whether a copy of an extension appears as available.

from CRM_Extension_Container_Basic
static array
convertPathsToUrls(string $dirSep, array $relPaths)

Convert a list of relative paths to relative URLs.

from CRM_Extension_Container_Basic

Details

in CRM_Extension_Container_Basic at line 103
__construct(string $baseDir, string $baseUrl, CRM_Utils_Cache_Interface $cache = NULL, string $cacheKey = NULL)

Parameters

string $baseDir Local path to the container.
string $baseUrl Public URL of the container.
CRM_Utils_Cache_Interface $cache Cache in which to store extension metadata.
string $cacheKey Unique name for this container.

at line 44
checkRequirements()

in CRM_Extension_Container_Basic at line 139
getKeys()

in CRM_Extension_Container_Basic at line 146
getPath(string $key)

Parameters

string $key Fully-qualified extension name.

in CRM_Extension_Container_Basic at line 153
getResUrl(string $key)

Parameters

string $key Fully-qualified extension name.

in CRM_Extension_Container_Basic at line 170
refresh()

in CRM_Extension_Container_Basic at line 180
string getBaseDir()

Return Value

string

in CRM_Extension_Container_Basic at line 193
protected string getRelPath(string $key)

Determine the relative path of an extension directory.

Parameters

string $key Extension name.

Return Value

string

Exceptions

CRM_Extension_Exception_MissingException

in CRM_Extension_Container_Basic at line 207
protected array getRelPaths()

Scan $basedir for a list of extension-keys

Return Value

array ($key => $relPath)

in CRM_Extension_Container_Basic at line 255
protected string getRelUrl(string $key)

Determine the relative path of an extension directory.

Parameters

string $key Extension name.

Return Value

string

Exceptions

CRM_Extension_Exception_MissingException

in CRM_Extension_Container_Basic at line 269
protected array getRelUrls()

Scan $basedir for a list of extension-keys

Return Value

array ($key => $relUrl)

in CRM_Extension_Container_Basic at line 288
$this addFilter(callable $callable)

Register a filter which determine whether a copy of an extension appears as available.

Parameters

callable $callable function(CRM_Extension_Info $info): bool Each function returns TRUE if the extension should be visible.

Return Value

$this

in CRM_Extension_Container_Basic at line 305
static array convertPathsToUrls(string $dirSep, array $relPaths)

Convert a list of relative paths to relative URLs.

Note: Treat as private. This is only public to facilitate testing.

Parameters

string $dirSep Directory separator ("/" or "\").
array $relPaths Array($key => $relPath).

Return Value

array Array($key => $relUrl).