class CurrentModule extends AbstractObject implements IdAble

Reflective module API provided to functions at runtime.

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

id()

A unique identifier for this CurrentModule.

string
name()

The name of the module being executed in

source()

The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).

workdir(string $path, array|null $exclude = null, array|null $include = null)

Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.

workdirFile(string $path)

Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 19
AbstractId id()

A unique identifier for this CurrentModule.

Return Value

AbstractId

at line 28
string name()

The name of the module being executed in

Return Value

string

at line 37
Directory source()

The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).

Return Value

Directory

at line 46
Directory workdir(string $path, array|null $exclude = null, array|null $include = null)

Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.

Parameters

string $path
array|null $exclude
array|null $include

Return Value

Directory

at line 62
File workdirFile(string $path)

Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.

Parameters

string $path

Return Value

File