1. class
  2. Civi
  3. \
  4. Angular
  5. \
  6. ChangeSet

ChangeSet

class ChangeSet implements ChangeSetInterface

Properties

protected string $name
protected array $resFilters
protected array $htmlFilters

Methods

static mixed
applyResourceFilters(array $changeSets, string $resourceType, array $resources)

Update a listing of resources.

static ChangeSetInterface
create(string $name)

No description

ChangeSet
requires(string $module, string|array $dependencies)

Declare that $module requires additional dependencies.

ChangeSet
alterResource(string $resourceType, callable $callback)

Declare a change to a resource.

ChangeSet
alterHtml(string $file, callable $callback)

Declare a change to HTML.

string
createRegex(string $filterExpr)

Convert a string with a wildcard (*) to a regex.

string
getName()

No description

setName(string $name)

No description

Details

at line 17
static mixed applyResourceFilters(array $changeSets, string $resourceType, array $resources)

Update a listing of resources.

Parameters

array $changeSets Array(ChangeSet).
string $resourceType Ex: 'requires', 'settings'
array $resources The list of resources.

Return Value

mixed

at line 97
static ChangeSetInterface create(string $name)

Parameters

string $name Symbolic name for this changeset.

Return Value

ChangeSetInterface

at line 110
ChangeSet requires(string $module, string|array $dependencies)

Declare that $module requires additional dependencies.

Parameters

string $module
string|array $dependencies

Return Value

ChangeSet

at line 129
ChangeSet alterResource(string $resourceType, callable $callback)

Declare a change to a resource.

Parameters

string $resourceType
callable $callback

Return Value

ChangeSet

at line 151
ChangeSet alterHtml(string $file, callable $callback)

Declare a change to HTML.

Parameters

string $file A file name, wildcard, or regex. Ex: '~/crmHello/intro.html' (filename) Ex: '~/crmHello/*.html' (wildcard) Ex: ';(Edit|List)Ctrl.html$;' (regex)
callable $callback Function which accepts up to two parameters: - phpQueryObject $doc - string $path

Return Value

ChangeSet

at line 167
protected string createRegex(string $filterExpr)

Convert a string with a wildcard (*) to a regex.

Parameters

string $filterExpr Ex: "/foo/*.bar"

Return Value

string Ex: ";^/foo/[^/]*.bar$;"

at line 177
string getName()

Return Value

string

at line 184
setName(string $name)

Parameters

string $name