1. class
  2. Dagger
  3. \
  4. Env

Env

class Env extends AbstractObject implements IdAble

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
Check
check(string $name)

Return the check with the given name from the installed modules. Must match exactly one check.

CheckGroup
checks(array|null $include = null)

Return all checks defined by the installed modules

AbstractId
id()

A unique identifier for this Env.

Binding
input(string $name)

Retrieves an input binding by name

array
inputs()

Returns all input bindings provided to the environment

Binding
output(string $name)

Retrieves an output binding by name

array
outputs()

Returns all declared output bindings for the environment

Env
withAddressInput(string $name, Address $value, string $description)

Create or update a binding of type Address in the environment

Env
withAddressOutput(string $name, string $description)

Declare a desired Address output to be assigned in the environment

Env
withCacheVolumeInput(string $name, CacheVolume $value, string $description)

Create or update a binding of type CacheVolume in the environment

Env
withCacheVolumeOutput(string $name, string $description)

Declare a desired CacheVolume output to be assigned in the environment

Env
withChangesetInput(string $name, Changeset $value, string $description)

Create or update a binding of type Changeset in the environment

Env
withChangesetOutput(string $name, string $description)

Declare a desired Changeset output to be assigned in the environment

Env
withCheckGroupInput(string $name, CheckGroup $value, string $description)

Create or update a binding of type CheckGroup in the environment

Env
withCheckGroupOutput(string $name, string $description)

Declare a desired CheckGroup output to be assigned in the environment

Env
withCheckInput(string $name, Check $value, string $description)

Create or update a binding of type Check in the environment

Env
withCheckOutput(string $name, string $description)

Declare a desired Check output to be assigned in the environment

Env
withCloudInput(string $name, Cloud $value, string $description)

Create or update a binding of type Cloud in the environment

Env
withCloudOutput(string $name, string $description)

Declare a desired Cloud output to be assigned in the environment

Env
withContainerInput(string $name, Container $value, string $description)

Create or update a binding of type Container in the environment

Env
withContainerOutput(string $name, string $description)

Declare a desired Container output to be assigned in the environment

Env
withCurrentModule()

Installs the current module into the environment, exposing its functions to the model

Env
withDirectoryInput(string $name, Directory $value, string $description)

Create or update a binding of type Directory in the environment

Env
withDirectoryOutput(string $name, string $description)

Declare a desired Directory output to be assigned in the environment

Env
withEnvFileInput(string $name, EnvFile $value, string $description)

Create or update a binding of type EnvFile in the environment

Env
withEnvFileOutput(string $name, string $description)

Declare a desired EnvFile output to be assigned in the environment

Env
withEnvInput(string $name, Env $value, string $description)

Create or update a binding of type Env in the environment

Env
withEnvOutput(string $name, string $description)

Declare a desired Env output to be assigned in the environment

Env
withFileInput(string $name, File $value, string $description)

Create or update a binding of type File in the environment

Env
withFileOutput(string $name, string $description)

Declare a desired File output to be assigned in the environment

Env
withGeneratorGroupInput(string $name, GeneratorGroup $value, string $description)

Create or update a binding of type GeneratorGroup in the environment

Env
withGeneratorGroupOutput(string $name, string $description)

Declare a desired GeneratorGroup output to be assigned in the environment

Env
withGeneratorInput(string $name, Generator $value, string $description)

Create or update a binding of type Generator in the environment

Env
withGeneratorOutput(string $name, string $description)

Declare a desired Generator output to be assigned in the environment

Env
withGitRefInput(string $name, GitRef $value, string $description)

Create or update a binding of type GitRef in the environment

Env
withGitRefOutput(string $name, string $description)

Declare a desired GitRef output to be assigned in the environment

Env
withGitRepositoryInput(string $name, GitRepository $value, string $description)

Create or update a binding of type GitRepository in the environment

Env
withGitRepositoryOutput(string $name, string $description)

Declare a desired GitRepository output to be assigned in the environment

Env
withJSONValueInput(string $name, JsonValue $value, string $description)

Create or update a binding of type JSONValue in the environment

Env
withJSONValueOutput(string $name, string $description)

Declare a desired JSONValue output to be assigned in the environment

Env
withMainModule(Module $module)

Sets the main module for this environment (the project being worked on)

Env
withModule(Module $module)

Installs a module into the environment, exposing its functions to the model

Env
withModuleConfigClientInput(string $name, ModuleConfigClient $value, string $description)

Create or update a binding of type ModuleConfigClient in the environment

Env
withModuleConfigClientOutput(string $name, string $description)

Declare a desired ModuleConfigClient output to be assigned in the environment

Env
withModuleInput(string $name, Module $value, string $description)

Create or update a binding of type Module in the environment

Env
withModuleOutput(string $name, string $description)

Declare a desired Module output to be assigned in the environment

Env
withModuleSourceInput(string $name, ModuleSource $value, string $description)

Create or update a binding of type ModuleSource in the environment

Env
withModuleSourceOutput(string $name, string $description)

Declare a desired ModuleSource output to be assigned in the environment

Env
withSearchResultInput(string $name, SearchResult $value, string $description)

Create or update a binding of type SearchResult in the environment

Env
withSearchResultOutput(string $name, string $description)

Declare a desired SearchResult output to be assigned in the environment

Env
withSearchSubmatchInput(string $name, SearchSubmatch $value, string $description)

Create or update a binding of type SearchSubmatch in the environment

Env
withSearchSubmatchOutput(string $name, string $description)

Declare a desired SearchSubmatch output to be assigned in the environment

Env
withSecretInput(string $name, Secret $value, string $description)

Create or update a binding of type Secret in the environment

Env
withSecretOutput(string $name, string $description)

Declare a desired Secret output to be assigned in the environment

Env
withServiceInput(string $name, Service $value, string $description)

Create or update a binding of type Service in the environment

Env
withServiceOutput(string $name, string $description)

Declare a desired Service output to be assigned in the environment

Env
withSocketInput(string $name, Socket $value, string $description)

Create or update a binding of type Socket in the environment

Env
withSocketOutput(string $name, string $description)

Declare a desired Socket output to be assigned in the environment

Env
withStatInput(string $name, Stat $value, string $description)

Create or update a binding of type Stat in the environment

Env
withStatOutput(string $name, string $description)

Declare a desired Stat output to be assigned in the environment

Env
withStringInput(string $name, string $value, string $description)

Provides a string input binding to the environment

Env
withStringOutput(string $name, string $description)

Declares a desired string output binding

Env
withWorkspace(Directory $workspace)

Returns a new environment with the provided workspace

Env
withoutOutputs()

Returns a new environment without any outputs

Directory
workspace()

No description

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 16
Check check(string $name)

Return the check with the given name from the installed modules. Must match exactly one check.

Parameters

string $name

Return Value

Check

at line 26
CheckGroup checks(array|null $include = null)

Return all checks defined by the installed modules

Parameters

array|null $include

Return Value

CheckGroup

at line 38
AbstractId id()

A unique identifier for this Env.

Return Value

AbstractId

at line 47
Binding input(string $name)

Retrieves an input binding by name

Parameters

string $name

Return Value

Binding

at line 57
array inputs()

Returns all input bindings provided to the environment

Return Value

array

at line 66
Binding output(string $name)

Retrieves an output binding by name

Parameters

string $name

Return Value

Binding

at line 76
array outputs()

Returns all declared output bindings for the environment

Return Value

array

at line 85
Env withAddressInput(string $name, Address $value, string $description)

Create or update a binding of type Address in the environment

Parameters

string $name
Address $value
string $description

Return Value

Env

at line 97
Env withAddressOutput(string $name, string $description)

Declare a desired Address output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 108
Env withCacheVolumeInput(string $name, CacheVolume $value, string $description)

Create or update a binding of type CacheVolume in the environment

Parameters

string $name
CacheVolume $value
string $description

Return Value

Env

at line 120
Env withCacheVolumeOutput(string $name, string $description)

Declare a desired CacheVolume output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 131
Env withChangesetInput(string $name, Changeset $value, string $description)

Create or update a binding of type Changeset in the environment

Parameters

string $name
Changeset $value
string $description

Return Value

Env

at line 143
Env withChangesetOutput(string $name, string $description)

Declare a desired Changeset output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 154
Env withCheckGroupInput(string $name, CheckGroup $value, string $description)

Create or update a binding of type CheckGroup in the environment

Parameters

string $name
CheckGroup $value
string $description

Return Value

Env

at line 166
Env withCheckGroupOutput(string $name, string $description)

Declare a desired CheckGroup output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 177
Env withCheckInput(string $name, Check $value, string $description)

Create or update a binding of type Check in the environment

Parameters

string $name
Check $value
string $description

Return Value

Env

at line 189
Env withCheckOutput(string $name, string $description)

Declare a desired Check output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 200
Env withCloudInput(string $name, Cloud $value, string $description)

Create or update a binding of type Cloud in the environment

Parameters

string $name
Cloud $value
string $description

Return Value

Env

at line 212
Env withCloudOutput(string $name, string $description)

Declare a desired Cloud output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 223
Env withContainerInput(string $name, Container $value, string $description)

Create or update a binding of type Container in the environment

Parameters

string $name
Container $value
string $description

Return Value

Env

at line 235
Env withContainerOutput(string $name, string $description)

Declare a desired Container output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 248
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.

Return Value

Env

at line 257
Env withDirectoryInput(string $name, Directory $value, string $description)

Create or update a binding of type Directory in the environment

Parameters

string $name
Directory $value
string $description

Return Value

Env

at line 269
Env withDirectoryOutput(string $name, string $description)

Declare a desired Directory output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 280
Env withEnvFileInput(string $name, EnvFile $value, string $description)

Create or update a binding of type EnvFile in the environment

Parameters

string $name
EnvFile $value
string $description

Return Value

Env

at line 292
Env withEnvFileOutput(string $name, string $description)

Declare a desired EnvFile output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 303
Env withEnvInput(string $name, Env $value, string $description)

Create or update a binding of type Env in the environment

Parameters

string $name
Env $value
string $description

Return Value

Env

at line 315
Env withEnvOutput(string $name, string $description)

Declare a desired Env output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 326
Env withFileInput(string $name, File $value, string $description)

Create or update a binding of type File in the environment

Parameters

string $name
File $value
string $description

Return Value

Env

at line 338
Env withFileOutput(string $name, string $description)

Declare a desired File output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 349
Env withGeneratorGroupInput(string $name, GeneratorGroup $value, string $description)

Create or update a binding of type GeneratorGroup in the environment

Parameters

string $name
GeneratorGroup $value
string $description

Return Value

Env

at line 364
Env withGeneratorGroupOutput(string $name, string $description)

Declare a desired GeneratorGroup output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 375
Env withGeneratorInput(string $name, Generator $value, string $description)

Create or update a binding of type Generator in the environment

Parameters

string $name
Generator $value
string $description

Return Value

Env

at line 387
Env withGeneratorOutput(string $name, string $description)

Declare a desired Generator output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 398
Env withGitRefInput(string $name, GitRef $value, string $description)

Create or update a binding of type GitRef in the environment

Parameters

string $name
GitRef $value
string $description

Return Value

Env

at line 410
Env withGitRefOutput(string $name, string $description)

Declare a desired GitRef output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 421
Env withGitRepositoryInput(string $name, GitRepository $value, string $description)

Create or update a binding of type GitRepository in the environment

Parameters

string $name
GitRepository $value
string $description

Return Value

Env

at line 436
Env withGitRepositoryOutput(string $name, string $description)

Declare a desired GitRepository output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 447
Env withJSONValueInput(string $name, JsonValue $value, string $description)

Create or update a binding of type JSONValue in the environment

Parameters

string $name
JsonValue $value
string $description

Return Value

Env

at line 459
Env withJSONValueOutput(string $name, string $description)

Declare a desired JSONValue output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 472
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.

Parameters

Module $module

Return Value

Env

at line 484
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.

Parameters

Module $module

Return Value

Env

at line 494
Env withModuleConfigClientInput(string $name, ModuleConfigClient $value, string $description)

Create or update a binding of type ModuleConfigClient in the environment

Parameters

string $name
ModuleConfigClient $value
string $description

Return Value

Env

at line 509
Env withModuleConfigClientOutput(string $name, string $description)

Declare a desired ModuleConfigClient output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 520
Env withModuleInput(string $name, Module $value, string $description)

Create or update a binding of type Module in the environment

Parameters

string $name
Module $value
string $description

Return Value

Env

at line 532
Env withModuleOutput(string $name, string $description)

Declare a desired Module output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 543
Env withModuleSourceInput(string $name, ModuleSource $value, string $description)

Create or update a binding of type ModuleSource in the environment

Parameters

string $name
ModuleSource $value
string $description

Return Value

Env

at line 555
Env withModuleSourceOutput(string $name, string $description)

Declare a desired ModuleSource output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 566
Env withSearchResultInput(string $name, SearchResult $value, string $description)

Create or update a binding of type SearchResult in the environment

Parameters

string $name
SearchResult $value
string $description

Return Value

Env

at line 578
Env withSearchResultOutput(string $name, string $description)

Declare a desired SearchResult output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 589
Env withSearchSubmatchInput(string $name, SearchSubmatch $value, string $description)

Create or update a binding of type SearchSubmatch in the environment

Parameters

string $name
SearchSubmatch $value
string $description

Return Value

Env

at line 604
Env withSearchSubmatchOutput(string $name, string $description)

Declare a desired SearchSubmatch output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 615
Env withSecretInput(string $name, Secret $value, string $description)

Create or update a binding of type Secret in the environment

Parameters

string $name
Secret $value
string $description

Return Value

Env

at line 627
Env withSecretOutput(string $name, string $description)

Declare a desired Secret output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 638
Env withServiceInput(string $name, Service $value, string $description)

Create or update a binding of type Service in the environment

Parameters

string $name
Service $value
string $description

Return Value

Env

at line 650
Env withServiceOutput(string $name, string $description)

Declare a desired Service output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 661
Env withSocketInput(string $name, Socket $value, string $description)

Create or update a binding of type Socket in the environment

Parameters

string $name
Socket $value
string $description

Return Value

Env

at line 673
Env withSocketOutput(string $name, string $description)

Declare a desired Socket output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 684
Env withStatInput(string $name, Stat $value, string $description)

Create or update a binding of type Stat in the environment

Parameters

string $name
Stat $value
string $description

Return Value

Env

at line 696
Env withStatOutput(string $name, string $description)

Declare a desired Stat output to be assigned in the environment

Parameters

string $name
string $description

Return Value

Env

at line 707
Env withStringInput(string $name, string $value, string $description)

Provides a string input binding to the environment

Parameters

string $name
string $value
string $description

Return Value

Env

at line 719
Env withStringOutput(string $name, string $description)

Declares a desired string output binding

Parameters

string $name
string $description

Return Value

Env

at line 730
Env withWorkspace(Directory $workspace)

Returns a new environment with the provided workspace

Parameters

Directory $workspace

Return Value

Env

at line 740
Env withoutOutputs()

Returns a new environment without any outputs

Return Value

Env

at line 746
Directory workspace()

No description

Return Value

Directory