CurrentModule
class CurrentModule extends AbstractObject implements IdAble, Node
Reflective module API provided to functions at runtime.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
The dependencies of the module.
The generated files and directories made on top of the module source's context directory.
Return all generators defined by the module
The name of the module being executed in
The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).
Load a directory 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.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
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 21
CurrentModuleAsSDK
asSDK(Workspace $workspace)
Treat the currently executing module as an SDK installed in the given workspace, exposing the modules and clients it manages.
Errors if the current module is not installed as an SDK in this workspace.
at line 31
array
dependencies()
The dependencies of the module.
at line 40
Directory
generatedContextDirectory()
The generated files and directories made on top of the module source's context directory.
at line 49
GeneratorGroup
generators(array|null $include = null)
Return all generators defined by the module
at line 61
Id
id()
A unique identifier for this CurrentModule.
at line 70
string
name()
The name of the module being executed in
at line 79
Directory
source()
The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).
at line 88
Directory
workdir(string $path, array|null $exclude = [], array|null $include = [], 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.
at line 111
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.