docs/static/reference/php/Dagger/Env.html
class Env extends AbstractObject implements IdAble
| | $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 with the given name from the installed modules. Must match exactly one check.
checks(array|null $include = null)
Return all checks defined by the installed modules
id()
A unique identifier for this Env.
input(string $name)
Retrieves an input binding by name
array
inputs()
Returns all input bindings provided to the environment
output(string $name)
Retrieves an output binding by name
array
outputs()
Returns all declared output bindings for the environment
services(array|null $include = null)
Return all services defined by the installed modules
withAddressInput(string $name, Address $value, string $description)
Create or update a binding of type Address in the environment
withAddressOutput(string $name, string $description)
Declare a desired Address output to be assigned in the environment
withCacheVolumeInput(string $name, CacheVolume $value, string $description)
Create or update a binding of type CacheVolume in the environment
withCacheVolumeOutput(string $name, string $description)
Declare a desired CacheVolume output to be assigned in the environment
withChangesetInput(string $name, Changeset $value, string $description)
Create or update a binding of type Changeset in the environment
withChangesetOutput(string $name, string $description)
Declare a desired Changeset output to be assigned in the environment
withCheckGroupInput(string $name, CheckGroup $value, string $description)
Create or update a binding of type CheckGroup in the environment
withCheckGroupOutput(string $name, string $description)
Declare a desired CheckGroup output to be assigned in the environment
withCheckInput(string $name, Check $value, string $description)
Create or update a binding of type Check in the environment
withCheckOutput(string $name, string $description)
Declare a desired Check output to be assigned in the environment
withCloudInput(string $name, Cloud $value, string $description)
Create or update a binding of type Cloud in the environment
withCloudOutput(string $name, string $description)
Declare a desired Cloud output to be assigned in the environment
withContainerInput(string $name, Container $value, string $description)
Create or update a binding of type Container in the environment
withContainerOutput(string $name, string $description)
Declare a desired Container output to be assigned in the environment
Installs the current module into the environment, exposing its functions to the model
withDiffStatInput(string $name, DiffStat $value, string $description)
Create or update a binding of type DiffStat in the environment
withDiffStatOutput(string $name, string $description)
Declare a desired DiffStat output to be assigned in the environment
withDirectoryInput(string $name, Directory $value, string $description)
Create or update a binding of type Directory in the environment
withDirectoryOutput(string $name, string $description)
Declare a desired Directory output to be assigned in the environment
withEnvFileInput(string $name, EnvFile $value, string $description)
Create or update a binding of type EnvFile in the environment
withEnvFileOutput(string $name, string $description)
Declare a desired EnvFile output to be assigned in the environment
withEnvInput(string $name, Env $value, string $description)
Create or update a binding of type Env in the environment
withEnvOutput(string $name, string $description)
Declare a desired Env output to be assigned in the environment
withFileInput(string $name, File $value, string $description)
Create or update a binding of type File in the environment
withFileOutput(string $name, string $description)
Declare a desired File output to be assigned in the environment
withGeneratorGroupInput(string $name, GeneratorGroup $value, string $description)
Create or update a binding of type GeneratorGroup in the environment
withGeneratorGroupOutput(string $name, string $description)
Declare a desired GeneratorGroup output to be assigned in the environment
withGeneratorInput(string $name, Generator $value, string $description)
Create or update a binding of type Generator in the environment
withGeneratorOutput(string $name, string $description)
Declare a desired Generator output to be assigned in the environment
withGitRefInput(string $name, GitRef $value, string $description)
Create or update a binding of type GitRef in the environment
withGitRefOutput(string $name, string $description)
Declare a desired GitRef output to be assigned in the environment
withGitRepositoryInput(string $name, GitRepository $value, string $description)
Create or update a binding of type GitRepository in the environment
withGitRepositoryOutput(string $name, string $description)
Declare a desired GitRepository output to be assigned in the environment
withJSONValueInput(string $name, JsonValue $value, string $description)
Create or update a binding of type JSONValue in the environment
withJSONValueOutput(string $name, string $description)
Declare a desired JSONValue output to be assigned in the environment
withMainModule(Module $module)
Sets the main module for this environment (the project being worked on)
withModule(Module $module)
Installs a module into the environment, exposing its functions to the model
withModuleConfigClientInput(string $name, ModuleConfigClient $value, string $description)
Create or update a binding of type ModuleConfigClient in the environment
withModuleConfigClientOutput(string $name, string $description)
Declare a desired ModuleConfigClient output to be assigned in the environment
withModuleInput(string $name, Module $value, string $description)
Create or update a binding of type Module in the environment
withModuleOutput(string $name, string $description)
Declare a desired Module output to be assigned in the environment
withModuleSourceInput(string $name, ModuleSource $value, string $description)
Create or update a binding of type ModuleSource in the environment
withModuleSourceOutput(string $name, string $description)
Declare a desired ModuleSource output to be assigned in the environment
withPhpSdkInput(string $name, PhpSdk $value, string $description)
Create or update a binding of type PhpSdk in the environment
withPhpSdkOutput(string $name, string $description)
Declare a desired PhpSdk output to be assigned in the environment
withSearchResultInput(string $name, SearchResult $value, string $description)
Create or update a binding of type SearchResult in the environment
withSearchResultOutput(string $name, string $description)
Declare a desired SearchResult output to be assigned in the environment
withSearchSubmatchInput(string $name, SearchSubmatch $value, string $description)
Create or update a binding of type SearchSubmatch in the environment
withSearchSubmatchOutput(string $name, string $description)
Declare a desired SearchSubmatch output to be assigned in the environment
withSecretInput(string $name, Secret $value, string $description)
Create or update a binding of type Secret in the environment
withSecretOutput(string $name, string $description)
Declare a desired Secret output to be assigned in the environment
withServiceInput(string $name, Service $value, string $description)
Create or update a binding of type Service in the environment
withServiceOutput(string $name, string $description)
Declare a desired Service output to be assigned in the environment
withSocketInput(string $name, Socket $value, string $description)
Create or update a binding of type Socket in the environment
withSocketOutput(string $name, string $description)
Declare a desired Socket output to be assigned in the environment
withStatInput(string $name, Stat $value, string $description)
Create or update a binding of type Stat in the environment
withStatOutput(string $name, string $description)
Declare a desired Stat output to be assigned in the environment
withStringInput(string $name, string $value, string $description)
Provides a string input binding to the environment
withStringOutput(string $name, string $description)
Declares a desired string output binding
withUpGroupInput(string $name, UpGroup $value, string $description)
Create or update a binding of type UpGroup in the environment
withUpGroupOutput(string $name, string $description)
Declare a desired UpGroup output to be assigned in the environment
withUpInput(string $name, Up $value, string $description)
Create or update a binding of type Up in the environment
withUpOutput(string $name, string $description)
Declare a desired Up output to be assigned in the environment
withWorkspace(Directory $workspace)
Returns a new environment with the provided workspace
withWorkspaceInput(string $name, Workspace $value, string $description)
Create or update a binding of type Workspace in the environment
withWorkspaceOutput(string $name, string $description)
Declare a desired Workspace output to be assigned in the environment
Returns a new environment without any outputs
No description
__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 with the given name from the installed modules. Must match exactly one check.
| string | $name | |
| Check | |
CheckGroup checks(array|null $include = null)Return all checks defined by the installed modules
| array|null | $include | |
| CheckGroup | |
AbstractId id()A unique identifier for this Env.
| AbstractId | |
Binding input(string $name)Retrieves an input binding by name
| string | $name | |
| Binding | |
array inputs()Returns all input bindings provided to the environment
| array | |
Binding output(string $name)Retrieves an output binding by name
| string | $name | |
| Binding | |
array outputs()Returns all declared output bindings for the environment
| array | |
UpGroup services(array|null $include = null)Return all services defined by the installed modules
| array|null | $include | |
| UpGroup | |
Env withAddressInput(string $name, Address $value, string $description)Create or update a binding of type Address in the environment
| string | $name | | | Address | $value | | | string | $description | |
| Env | |
Env withAddressOutput(string $name, string $description)Declare a desired Address output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withCacheVolumeInput(string $name, CacheVolume $value, string $description)Create or update a binding of type CacheVolume in the environment
| string | $name | | | CacheVolume | $value | | | string | $description | |
| Env | |
Env withCacheVolumeOutput(string $name, string $description)Declare a desired CacheVolume output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withChangesetInput(string $name, Changeset $value, string $description)Create or update a binding of type Changeset in the environment
| string | $name | | | Changeset | $value | | | string | $description | |
| Env | |
Env withChangesetOutput(string $name, string $description)Declare a desired Changeset output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withCheckGroupInput(string $name, CheckGroup $value, string $description)Create or update a binding of type CheckGroup in the environment
| string | $name | | | CheckGroup | $value | | | string | $description | |
| Env | |
Env withCheckGroupOutput(string $name, string $description)Declare a desired CheckGroup output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withCheckInput(string $name, Check $value, string $description)Create or update a binding of type Check in the environment
| string | $name | | | Check | $value | | | string | $description | |
| Env | |
Env withCheckOutput(string $name, string $description)Declare a desired Check output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withCloudInput(string $name, Cloud $value, string $description)Create or update a binding of type Cloud in the environment
| string | $name | | | Cloud | $value | | | string | $description | |
| Env | |
Env withCloudOutput(string $name, string $description)Declare a desired Cloud output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withContainerInput(string $name, Container $value, string $description)Create or update a binding of type Container in the environment
| string | $name | | | Container | $value | | | string | $description | |
| Env | |
Env withContainerOutput(string $name, string $description)Declare a desired Container output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withCurrentModule()Installs the current module into the environment, exposing its functions to the model
Contextual path arguments will be populated using the environment's workspace.
| Env | |
Env withDiffStatInput(string $name, DiffStat $value, string $description)Create or update a binding of type DiffStat in the environment
| string | $name | | | DiffStat | $value | | | string | $description | |
| Env | |
Env withDiffStatOutput(string $name, string $description)Declare a desired DiffStat output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withDirectoryInput(string $name, Directory $value, string $description)Create or update a binding of type Directory in the environment
| string | $name | | | Directory | $value | | | string | $description | |
| Env | |
Env withDirectoryOutput(string $name, string $description)Declare a desired Directory output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withEnvFileInput(string $name, EnvFile $value, string $description)Create or update a binding of type EnvFile in the environment
| string | $name | | | EnvFile | $value | | | string | $description | |
| Env | |
Env withEnvFileOutput(string $name, string $description)Declare a desired EnvFile output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withEnvInput(string $name, Env $value, string $description)Create or update a binding of type Env in the environment
| string | $name | | | Env | $value | | | string | $description | |
| Env | |
Env withEnvOutput(string $name, string $description)Declare a desired Env output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withFileInput(string $name, File $value, string $description)Create or update a binding of type File in the environment
| string | $name | | | File | $value | | | string | $description | |
| Env | |
Env withFileOutput(string $name, string $description)Declare a desired File output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withGeneratorGroupInput(string $name, GeneratorGroup $value, string $description)Create or update a binding of type GeneratorGroup in the environment
| string | $name | | | GeneratorGroup | $value | | | string | $description | |
| Env | |
Env withGeneratorGroupOutput(string $name, string $description)Declare a desired GeneratorGroup output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withGeneratorInput(string $name, Generator $value, string $description)Create or update a binding of type Generator in the environment
| string | $name | | | Generator | $value | | | string | $description | |
| Env | |
Env withGeneratorOutput(string $name, string $description)Declare a desired Generator output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withGitRefInput(string $name, GitRef $value, string $description)Create or update a binding of type GitRef in the environment
| string | $name | | | GitRef | $value | | | string | $description | |
| Env | |
Env withGitRefOutput(string $name, string $description)Declare a desired GitRef output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withGitRepositoryInput(string $name, GitRepository $value, string $description)Create or update a binding of type GitRepository in the environment
| string | $name | | | GitRepository | $value | | | string | $description | |
| Env | |
Env withGitRepositoryOutput(string $name, string $description)Declare a desired GitRepository output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withJSONValueInput(string $name, JsonValue $value, string $description)Create or update a binding of type JSONValue in the environment
| string | $name | | | JsonValue | $value | | | string | $description | |
| Env | |
Env withJSONValueOutput(string $name, string $description)Declare a desired JSONValue output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withMainModule(Module $module)Sets the main module for this environment (the project being worked on)
Contextual path arguments will be populated using the environment's workspace.
| Module | $module | |
| Env | |
Env withModule(Module $module)Installs a module into the environment, exposing its functions to the model
Contextual path arguments will be populated using the environment's workspace.
| Module | $module | |
| Env | |
Env withModuleConfigClientInput(string $name, ModuleConfigClient $value, string $description)Create or update a binding of type ModuleConfigClient in the environment
| string | $name | | | ModuleConfigClient | $value | | | string | $description | |
| Env | |
Env withModuleConfigClientOutput(string $name, string $description)Declare a desired ModuleConfigClient output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withModuleInput(string $name, Module $value, string $description)Create or update a binding of type Module in the environment
| string | $name | | | Module | $value | | | string | $description | |
| Env | |
Env withModuleOutput(string $name, string $description)Declare a desired Module output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withModuleSourceInput(string $name, ModuleSource $value, string $description)Create or update a binding of type ModuleSource in the environment
| string | $name | | | ModuleSource | $value | | | string | $description | |
| Env | |
Env withModuleSourceOutput(string $name, string $description)Declare a desired ModuleSource output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withPhpSdkInput(string $name, PhpSdk $value, string $description)Create or update a binding of type PhpSdk in the environment
| string | $name | | | PhpSdk | $value | | | string | $description | |
| Env | |
Env withPhpSdkOutput(string $name, string $description)Declare a desired PhpSdk output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withSearchResultInput(string $name, SearchResult $value, string $description)Create or update a binding of type SearchResult in the environment
| string | $name | | | SearchResult | $value | | | string | $description | |
| Env | |
Env withSearchResultOutput(string $name, string $description)Declare a desired SearchResult output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withSearchSubmatchInput(string $name, SearchSubmatch $value, string $description)Create or update a binding of type SearchSubmatch in the environment
| string | $name | | | SearchSubmatch | $value | | | string | $description | |
| Env | |
Env withSearchSubmatchOutput(string $name, string $description)Declare a desired SearchSubmatch output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withSecretInput(string $name, Secret $value, string $description)Create or update a binding of type Secret in the environment
| string | $name | | | Secret | $value | | | string | $description | |
| Env | |
Env withSecretOutput(string $name, string $description)Declare a desired Secret output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withServiceInput(string $name, Service $value, string $description)Create or update a binding of type Service in the environment
| string | $name | | | Service | $value | | | string | $description | |
| Env | |
Env withServiceOutput(string $name, string $description)Declare a desired Service output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withSocketInput(string $name, Socket $value, string $description)Create or update a binding of type Socket in the environment
| string | $name | | | Socket | $value | | | string | $description | |
| Env | |
Env withSocketOutput(string $name, string $description)Declare a desired Socket output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withStatInput(string $name, Stat $value, string $description)Create or update a binding of type Stat in the environment
| string | $name | | | Stat | $value | | | string | $description | |
| Env | |
Env withStatOutput(string $name, string $description)Declare a desired Stat output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withStringInput(string $name, string $value, string $description)Provides a string input binding to the environment
| string | $name | | | string | $value | | | string | $description | |
| Env | |
Env withStringOutput(string $name, string $description)Declares a desired string output binding
| string | $name | | | string | $description | |
| Env | |
Env withUpGroupInput(string $name, UpGroup $value, string $description)Create or update a binding of type UpGroup in the environment
| string | $name | | | UpGroup | $value | | | string | $description | |
| Env | |
Env withUpGroupOutput(string $name, string $description)Declare a desired UpGroup output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withUpInput(string $name, Up $value, string $description)Create or update a binding of type Up in the environment
| string | $name | | | Up | $value | | | string | $description | |
| Env | |
Env withUpOutput(string $name, string $description)Declare a desired Up output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withWorkspace(Directory $workspace)Returns a new environment with the provided workspace
| Directory | $workspace | |
| Env | |
Env withWorkspaceInput(string $name, Workspace $value, string $description)Create or update a binding of type Workspace in the environment
| string | $name | | | Workspace | $value | | | string | $description | |
| Env | |
Env withWorkspaceOutput(string $name, string $description)Declare a desired Workspace output to be assigned in the environment
| string | $name | | | string | $description | |
| Env | |
Env withoutOutputs()Returns a new environment without any outputs
| Env | |
Directory workspace()No description
| Directory | |
Generated by Doctum, a API Documentation generator and fork of Sami.