Documentation

CRM_Core_Resources_CollectionTrait uses trait:short

Class CRM_Core_Resources_CollectionTrait

This is a building-block for creating classes which maintain a list of resources. It implements of the CollectionInterface.

Properties

$defaults : array<string|int, mixed>: Static defaults - a list of options to apply to any new snippets.
$isSorted : bool: Whether the snippets array has been sorted
$snippets : array<string|int, mixed>: List of snippets to inject within region.
$types : array<string|int, mixed>: Whitelist of supported types.

Methods

_cmpSnippet() : int
add() : array<string|int, mixed>: Add an item to the collection.
addBundle() : static: Assimilate all the resources listed in a bundle.
addMarkup() : static: Add an HTML blob.
addModule() : static: Add an ECMAScript module (ESM) to the current page (<SCRIPT TYPE=MODULE>).
addModuleFile() : static: Add an ECMAScript Module (ESM) from file to the current page (<SCRIPT TYPE=MODULE SRC=...>).
addModuleUrl() : static: Add an ECMAScript Module (ESM) by URL to the current page (<SCRIPT TYPE=MODULE SRC=...>).
addPermissions() : static: Export permission data to the client to enable smarter GUIs.
addScript() : static: Add a JavaScript file to the current page using <SCRIPT SRC>.
addScriptFile() : static: Add a JavaScript file to the current page using <SCRIPT SRC>.
addScriptUrl() : static: Add a JavaScript URL to the current page using <SCRIPT SRC>.
addSetting() : static: Add JavaScript variables to the root of the CRM object.
addSettingsFactory() : static: Add JavaScript variables to the global CRM object via a callback function.
addString() : static: Add translated string to the js CRM object.
addStyle() : static: Add a CSS content to the current page using <STYLE>.
addStyleFile() : static: Add a CSS file to the current page using <LINK HREF>.
addStyleUrl() : static: Add a CSS file to the current page using <LINK HREF>.
addVars() : static: Add JavaScript variables to CRM.vars
clear() : static: Remove all snippets.
filter() : static: Alter the contents of the collection.
find() : iterable<string|int, mixed>: Find all snippets which match the given criterion.
findCreateSettingSnippet() : array<string|int, mixed>
get() : array<string|int, mixed>|null: Get snippet.
getAll() : iterable<string|int, mixed>: Get a list of all snippets in this collection.
getSettings() : array<string|int, mixed>: Get a fully-formed/altered list of settings, including the results of any callbacks/listeners.
merge() : static: Assimilate a list of resources into this list.
mergeSettingOptions() : array<string|int, mixed>: Given the "$options" for "addSetting()" (etal), normalize the contents and potentially add more.
mergeSettings() : array<string|int, mixed>
mergeStandardOptions() : array<string|int, mixed>: Given the "$options" for "addScriptUrl()" (etal), normalize the contents and potentially add more.
update() : static: Update specific properties of a snippet.
nextId() : mixed
resolveName() : mixed
sort() : static: Ensure that the collection is sorted.

$defaults

Static defaults - a list of options to apply to any new snippets.


        protected
            array<string|int, mixed>
    $defaults
     = ['weight' => 1, 'disabled' => \FALSE]

$isSorted

Whether the snippets array has been sorted


        protected
            bool
    $isSorted
     = \TRUE

$snippets

List of snippets to inject within region.


        protected
            array<string|int, mixed>
    $snippets
     = []

e.g. $this->_snippets[3]['type'] = 'template';

$types

Whitelist of supported types.


        protected
            array<string|int, mixed>
    $types
     = []

_cmpSnippet()


    public
            static        _cmpSnippet(mixed $a, mixed $b) : int

Parameters

$a : mixed
$b : mixed

Return values

int

add()

Add an item to the collection.


    public
                    add(array<string|int, mixed> $snippet) : array<string|int, mixed>

Parameters

$snippet : array<string|int, mixed>: Resource options. See CollectionInterface docs.

Return values

array<string|int, mixed> —

The full/computed snippet (with defaults applied).

addBundle()

Assimilate all the resources listed in a bundle.


    public
                    addBundle(iterable<string|int, mixed>|string|CRM_Core_Resources_Bundle $bundle) : static

Parameters

$bundle : iterable<string|int, mixed>|string|CRM_Core_Resources_Bundle: Either bundle object, or the symbolic name of a bundle. Note: For symbolic names, the bundle must be a container service ('bundle.FOO').

Return values

static

addMarkup()

Add an HTML blob.


    public
                    addMarkup(string $markup, array<string|int, mixed> ...$options) : static

Ex: addMarkup('

Hello world!

', ['weight' => 123]);

Parameters

$markup : string: HTML code.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addMarkup(string $code, int $weight, string $region).

Return values

static

addModule()

Add an ECMAScript module (ESM) to the current page (<SCRIPT TYPE=MODULE>).


    public
                    addModule(string $code, array<string|int, mixed> ...$options) : static

Ex: addModule('alert("Hello world");', ['weight' => 123]);

Parameters

$code : string: JavaScript source code.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addModule(string $code, int $weight, string $region).

Return values

static

addModuleFile()

Add an ECMAScript Module (ESM) from file to the current page (<SCRIPT TYPE=MODULE SRC=...>).


    public
                    addModuleFile(string $ext, string $file, array<string|int, mixed> ...$options) : static

Ex: addModuleFile('myextension', 'myscript.js', ['weight' => 123]);

Parameters

$ext : string: Extension name; use 'civicrm' for core.
$file : string: File path -- relative to the extension base dir.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addModuleFile(string $code, int $weight, string $region, mixed $translate).

Return values

static

addModuleUrl()

Add an ECMAScript Module (ESM) by URL to the current page (<SCRIPT TYPE=MODULE SRC=...>).


    public
                    addModuleUrl(string $url, array<string|int, mixed> ...$options) : static

Ex: addModuleUrl('http://example.com/foo.js', ['weight' => 123])

Parameters

$url : string
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addModuleUrl(string $url, int $weight, string $region).

Return values

static

addPermissions()

Export permission data to the client to enable smarter GUIs.


    public
                    addPermissions(string|iterable<string|int, mixed> $permNames) : static

Parameters

$permNames : string|iterable<string|int, mixed>: List of permission names to check/export.

Return values

static

addScript()

Add a JavaScript file to the current page using <SCRIPT SRC>.


    public
                    addScript(string $code, array<string|int, mixed> ...$options) : static

Ex: addScript('alert("Hello world");', ['weight' => 123]);

Parameters

$code : string: JavaScript source code.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addScript(string $code, int $weight, string $region).

Return values

static

addScriptFile()

Add a JavaScript file to the current page using <SCRIPT SRC>.


    public
                    addScriptFile(string $ext, string $file, array<string|int, mixed> ...$options) : static

Ex: addScriptFile('myextension', 'myscript.js', ['weight' => 123]);

Parameters

$ext : string: Extension name; use 'civicrm' for core.
$file : string: File path -- relative to the extension base dir.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addScriptFile(string $code, int $weight, string $region, mixed $translate).

Return values

static

addScriptUrl()

Add a JavaScript URL to the current page using <SCRIPT SRC>.


    public
                    addScriptUrl(string $url, array<string|int, mixed> ...$options) : static

Ex: addScriptUrl('http://example.com/foo.js', ['weight' => 123])

Parameters

$url : string
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addScriptUrl(string $url, int $weight, string $region).

Return values

static

addSetting()

Add JavaScript variables to the root of the CRM object.


    public
                    addSetting(array<string|int, mixed> $settings, array<string|int, mixed> ...$options) : static

This function is usually reserved for low-level system use. Extensions and components should generally use addVars instead.

Parameters

$settings : array<string|int, mixed>: Data to export.
$options : array<string|int, mixed>: Not used. Positional equivalence: addSetting(array $settings, string $region).

Return values

static

addSettingsFactory()

Add JavaScript variables to the global CRM object via a callback function.


    public
                    addSettingsFactory(callable $callable) : static

Parameters

$callable : callable

Return values

static

addString()

Add translated string to the js CRM object.


    public
                    addString(string|array<string|int, mixed> $text[, string|null $domain = 'civicrm' ]) : static

It can then be retrived from the client-side ts() function Variable substitutions can happen from client-side

Note: this function rarely needs to be called directly and is mostly for internal use. See CRM_Core_Resources::addScriptFile which automatically adds translated strings from js files

Simple example: // From php: CRM_Core_Resources::singleton()->addString('Hello'); // The string is now available to javascript code i.e. ts('Hello');

Example with client-side substitutions: // From php: CRM_Core_Resources::singleton()->addString('Your %1 has been %2'); // ts() in javascript works the same as in php, for example: ts('Your %1 has been %2', {1: objectName, 2: actionTaken});

NOTE: This function does not work with server-side substitutions (as this might result in collisions and unwanted variable injections) Instead, use code like: CRM_Core_Resources::singleton()->addSetting(array('myNamespace' => array('myString' => ts('Your %1 has been %2', array(subs))))); And from javascript access it at CRM.myNamespace.myString

Parameters

$text : string|array<string|int, mixed>
$domain : string|null = 'civicrm'

Return values

static

addStyle()

Add a CSS content to the current page using <STYLE>.


    public
                    addStyle(string $code, array<string|int, mixed> ...$options) : static

Ex: addStyle('p { color: red; }', ['weight' => 100]);

Parameters

$code : string: CSS source code.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addStyle(string $code, int $weight, string $region).

Return values

static

addStyleFile()

Add a CSS file to the current page using <LINK HREF>.


    public
                    addStyleFile(string $ext, string $file, array<string|int, mixed> ...$options) : static

Ex: addStyleFile('myextension', 'mystyles.css', ['weight' => 100]);

Parameters

$ext : string: Extension name; use 'civicrm' for core.
$file : string: File path -- relative to the extension base dir.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addStyle(string $code, int $weight, string $region).

Return values

static

addStyleUrl()

Add a CSS file to the current page using <LINK HREF>.


    public
                    addStyleUrl(string $url, array<string|int, mixed> ...$options) : static

Ex: addStyleUrl('http://example.com/foo.css', ['weight' => 100]);

Parameters

$url : string
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addStyleUrl(string $code, int $weight, string $region).

Return values

static

addVars()

Add JavaScript variables to CRM.vars


    public
                    addVars(string $nameSpace, array<string|int, mixed> $vars, array<string|int, mixed> ...$options) : static

Example: From the server: CRM_Core_Resources::singleton()->addVars('myNamespace', array('foo' => 'bar')); Access var from javascript: CRM.vars.myNamespace.foo // "bar"

Parameters

$nameSpace : string: Usually the name of your extension.
$vars : array<string|int, mixed>: Data to export.
$options : array<string|int, mixed>: Open-ended list of key-value options. See CollectionInterface docs. Positional equivalence: addVars(string $namespace, array $vars, string $region).

Return values

static

clear()

Remove all snippets.


    public
                    clear() : static

Return values

static

filter()

Alter the contents of the collection.


    public
                    filter(callable $callback) : static

Parameters

$callback : callable

The callback is invoked once for each member in the collection. The callback may return one of three values:

TRUE: The item is OK and belongs in the collection.
FALSE: The item is not OK and should be omitted from the collection.
Array: The item should be revised (using the returned value).

Return values

static

find()

Find all snippets which match the given criterion.


    public
                    find(callable $callback) : iterable<string|int, mixed>

Parameters

$callback : callable

The callback is invoked once for each member in the collection. The callback may return one of three values:

TRUE: The item is OK and belongs in the collection.
FALSE: The item is not OK and should be omitted from the collection.

Return values

iterable<string|int, mixed> —

List of matching snippets.

findCreateSettingSnippet()


    public
                &    findCreateSettingSnippet([mixed $options = [] ]) : array<string|int, mixed>

Parameters

$options : mixed = []

Return values

array<string|int, mixed>

get()

Get snippet.


    public
                &    get(string $name) : array<string|int, mixed>|null

Parameters

$name : string

Return values

array<string|int, mixed>|null

getAll()

Get a list of all snippets in this collection.


    public
                    getAll() : iterable<string|int, mixed>

Return values

iterable<string|int, mixed>

getSettings()

Get a fully-formed/altered list of settings, including the results of any callbacks/listeners.


    public
                    getSettings() : array<string|int, mixed>

Return values

array<string|int, mixed>

merge()

Assimilate a list of resources into this list.


    public
                    merge(iterable<string|int, mixed> $snippets) : static

Parameters

$snippets : iterable<string|int, mixed>: List of snippets to add.

Return values

static

mergeSettingOptions()

Given the "$options" for "addSetting()" (etal), normalize the contents and potentially add more.


    public
            static        mergeSettingOptions(array<string|int, mixed> $splats[, array<string|int, mixed> $defaults = [] ]) : array<string|int, mixed>

Parameters

$splats : array<string|int, mixed>

A list of options, as represented by the splat mechanism ("...$options"). This may appear in one of two ways:

New (String Index): as in addFoo($foo, array $options)
Old (Numeric Index): as in addFoo($foo, int $weight = X, string $region = Y, bool $translate = X)

$defaults : array<string|int, mixed> = []

List of values to merge into $options.

Return values

array<string|int, mixed>

mergeSettings()


    public
            static        mergeSettings(array<string|int, mixed> $settings, array<string|int, mixed> $additions) : array<string|int, mixed>

Parameters

$settings : array<string|int, mixed>
$additions : array<string|int, mixed>

Return values

array<string|int, mixed> —

combination of $settings and $additions

mergeStandardOptions()

Given the "$options" for "addScriptUrl()" (etal), normalize the contents and potentially add more.


    public
            static        mergeStandardOptions(array<string|int, mixed> $splats[, array<string|int, mixed> $defaults = [] ]) : array<string|int, mixed>

Parameters

$splats : array<string|int, mixed>

A list of options, as represented by the splat mechanism ("...$options"). This may appear in one of two ways:

New (String Index): as in addFoo($foo, array $options)
Old (Numeric Index): as in addFoo($foo, int $weight = X, string $region = Y, bool $translate = X)

$defaults : array<string|int, mixed> = []

List of values to merge into $options.

Return values

array<string|int, mixed>

update()

Update specific properties of a snippet.


    public
                    update(string $name, array<string|int, mixed> $snippet) : static

Parameters

$name : string: Symbolic of the resource/snippet to update.
$snippet : array<string|int, mixed>: Resource options. See CollectionInterface docs.

Return values

static

nextId()


    protected
                    nextId() : mixed

resolveName()


    protected
                    resolveName(string $name) : mixed

Parameters

$name : string: Name or alias. return array List of real names.

sort()

Ensure that the collection is sorted.


    protected
                    sort() : static

Return values

static

CRM_Core_Resources_CollectionTrait uses trait:short

Tags

Table of Contents

Properties

Methods

Properties

$defaults

$isSorted

$snippets

$types

Methods

_cmpSnippet()

Parameters

Return values

add()

Parameters

Tags

Return values

addBundle()

Parameters

Return values

addMarkup()

Parameters

Tags

Return values

addModule()

Parameters

Tags

Return values

addModuleFile()

Parameters

Tags

Return values

addModuleUrl()

Parameters

Tags

Return values

addPermissions()

Parameters

Tags

Return values

addScript()

Parameters

Tags

Return values

addScriptFile()

Parameters

Tags

Return values

addScriptUrl()

Parameters

Tags

Return values

addSetting()

Parameters

Tags

Return values

addSettingsFactory()

Parameters

Tags

Return values

addString()

Parameters

Tags

Return values

addStyle()

Parameters

Tags

Return values

addStyleFile()

Parameters

Tags

Return values

addStyleUrl()

Parameters

Tags

Return values

addVars()

Parameters

Tags