CurrentModule

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

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

array

dependencies()

The dependencies of the module.

Directory

generatedContextDirectory()

The generated files and directories made on top of the module source's context directory.

GeneratorGroup

generators(array|null $include = null)

Return all generators defined by the module

AbstractId

id()

A unique identifier for this CurrentModule.

string

name()

The name of the module being executed in

Directory

source()

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

Directory

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

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

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.

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 array dependencies()

The dependencies of the module.

Return Value

| array | |

at line 28 Directory generatedContextDirectory()

The generated files and directories made on top of the module source's context directory.

Return Value

| Directory | |

at line 37 GeneratorGroup generators(array|null $include = null)

Return all generators defined by the module

Parameters

| array|null | $include | |

Return Value

| GeneratorGroup | |

at line 49 AbstractId id()

A unique identifier for this CurrentModule.

Return Value

| AbstractId | |

at line 58 string name()

The name of the module being executed in

Return Value

| string | |

at line 67 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 76 Directory workdir(string $path, array|null $exclude = null, array|null $include = null, bool|null $gitignore = false)

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 | | | bool|null | $gitignore | |

Return Value

| Directory | |

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

Generated by Doctum, a API Documentation generator and fork of Sami.