Documentation

ChangeSetInterface
in

Table of Contents

Methods

alterHtml()  : ChangeSet
Declare a change to HTML.
getName()  : string
Get the symbolic name of the changeset.
requires()  : ChangeSet
Declare that $module requires additional dependencies.

Methods

alterHtml()

Declare a change to HTML.

public alterHtml(string $file, callable $callback) : ChangeSet
Parameters
$file : string

A file name, wildcard, or regex. Ex: '~/crmHello/intro.html' (filename) Ex: '~/crmHello/*.html' (wildcard) Ex: ';(Edit|List)Ctrl.html$;' (regex)

$callback : callable

Function which accepts up to two parameters:

  • phpQueryObject $doc
  • string $path
Return values
ChangeSet

getName()

Get the symbolic name of the changeset.

public getName() : string
Return values
string

requires()

Declare that $module requires additional dependencies.

public requires(string $module, string|array<string|int, mixed> $dependencies) : ChangeSet
Parameters
$module : string
$dependencies : string|array<string|int, mixed>
Return values
ChangeSet 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results