1. interface
  2. Civi
  3. \
  4. Angular
  5. \
  6. ChangeSetInterface

ChangeSetInterface

interface ChangeSetInterface

Methods

string
getName()

Get the symbolic name of the changeset.

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

Declare that $module requires additional dependencies.

ChangeSet
alterHtml(string $file, callable $callback)

Declare a change to HTML.

Details

at line 11
string getName()

Get the symbolic name of the changeset.

Return Value

string

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

Declare that $module requires additional dependencies.

Parameters

string $module
string|array $dependencies

Return Value

ChangeSet

at line 36
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