docs/static/reference/php/Dagger/Module.html
class Module extends AbstractObject implements IdAble
A Dagger module.
| | $lastQuery | | from AbstractObject |
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
from AbstractObject
null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
from AbstractObject
check(string $name)
Return the check defined by the module with the given name. Must match to exactly one check.
checks(array|null $include = null)
Return all checks defined by the module
array
The dependencies of the module.
string
The doc string of the module, if any
array
enums()
Enumerations served by this module.
The generated files and directories made on top of the module source's context directory.
generator(string $name)
Return the generator defined by the module with the given name. Must match to exactly one generator.
generators(array|null $include = null)
Return all generators defined by the module
id()
A unique identifier for this Module.
array
Interfaces served by this module.
The introspection schema JSON file for this module.
string
name()
The name of the module
array
objects()
Objects served by this module.
runtime()
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
sdk()
The SDK config used by this module.
void
serve(bool|null $includeDependencies = null, bool|null $entrypoint = null)
Serve a module's API in the current session.
services(array|null $include = null)
Return all services defined by the module
source()
The source for the module.
sync()
Forces evaluation of the module, including any loading into the engine and associated validation.
User-defined default values, loaded from local .env files.
withDescription(string $description)
Retrieves the module with the given description
withEnum(TypeDef $enum)
This module plus the given Enum type and associated values
withInterface(TypeDef $iface)
This module plus the given Interface type and associated functions
withObject(TypeDef $object)
This module plus the given Object type and associated functions.
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain) No description
| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)No description
| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |
| null|array|string|int|float|bool | |
Check check(string $name)Return the check defined by the module with the given name. Must match to exactly one check.
| string | $name | |
| Check | |
CheckGroup checks(array|null $include = null)Return all checks defined by the module
| array|null | $include | |
| CheckGroup | |
array dependencies()The dependencies of the module.
| array | |
string description()The doc string of the module, if any
| string | |
array enums()Enumerations served by this module.
| array | |
Directory generatedContextDirectory()The generated files and directories made on top of the module source's context directory.
| Directory | |
Generator generator(string $name)Return the generator defined by the module with the given name. Must match to exactly one generator.
| string | $name | |
| Generator | |
GeneratorGroup generators(array|null $include = null)Return all generators defined by the module
| array|null | $include | |
| GeneratorGroup | |
AbstractId id()A unique identifier for this Module.
| AbstractId | |
array interfaces()Interfaces served by this module.
| array | |
File introspectionSchemaJSON()The introspection schema JSON file for this module.
This file represents the schema visible to the module's source code, including all core types and those from the dependencies.
Note: this is in the context of a module, so some core types may be hidden.
| File | |
string name()The name of the module
| string | |
array objects()Objects served by this module.
| array | |
Container runtime()The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
| Container | |
SDKConfig sdk()The SDK config used by this module.
| SDKConfig | |
void serve(bool|null $includeDependencies = null, bool|null $entrypoint = null)Serve a module's API in the current session.
Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
| bool|null | $includeDependencies | | | bool|null | $entrypoint | |
| void | |
UpGroup services(array|null $include = null)Return all services defined by the module
| array|null | $include | |
| UpGroup | |
ModuleSource source()The source for the module.
| ModuleSource | |
ModuleId sync()Forces evaluation of the module, including any loading into the engine and associated validation.
| ModuleId | |
EnvFile userDefaults()User-defined default values, loaded from local .env files.
| EnvFile | |
Module withDescription(string $description)Retrieves the module with the given description
| string | $description | |
| Module | |
Module withEnum(TypeDef $enum)This module plus the given Enum type and associated values
| TypeDef | $enum | |
| Module | |
Module withInterface(TypeDef $iface)This module plus the given Interface type and associated functions
| TypeDef | $iface | |
| Module | |
Module withObject(TypeDef $object)This module plus the given Object type and associated functions.
| TypeDef | $object | |
| Module | |
Generated by Doctum, a API Documentation generator and fork of Sami.