Env
class Env extends AbstractObject implements IdAble, Node
Properties
| $lastQuery | from AbstractObject |
Methods
No description
Return the check with the given name from the installed modules. Must match exactly one check.
Return all checks defined by the installed modules
Returns all input bindings provided to the environment
Returns all declared output bindings for the environment
Create or update a binding of type Address in the environment
Declare a desired Address output to be assigned in the environment
Create or update a binding of type CacheVolume in the environment
Declare a desired CacheVolume output to be assigned in the environment
Create or update a binding of type Changeset in the environment
Declare a desired Changeset output to be assigned in the environment
Create or update a binding of type CheckGroup in the environment
Declare a desired CheckGroup output to be assigned in the environment
Create or update a binding of type Check in the environment
Declare a desired Check output to be assigned in the environment
Create or update a binding of type Cloud in the environment
Declare a desired Cloud output to be assigned in the environment
Create or update a binding of type Container in the environment
Declare a desired Container output to be assigned in the environment
Installs the current module into the environment, exposing its functions to the model
Create or update a binding of type CurrentModuleAsSDKClient in the environment
Declare a desired CurrentModuleAsSDKClient output to be assigned in the environment
Create or update a binding of type CurrentModuleAsSDK in the environment
Create or update a binding of type CurrentModuleAsSDKModule in the environment
Declare a desired CurrentModuleAsSDKModule output to be assigned in the environment
Declare a desired CurrentModuleAsSDK output to be assigned in the environment
Create or update a binding of type DiffStat in the environment
Declare a desired DiffStat output to be assigned in the environment
Create or update a binding of type Directory in the environment
Declare a desired Directory output to be assigned in the environment
Create or update a binding of type EnvFile in the environment
Declare a desired EnvFile output to be assigned in the environment
Create or update a binding of type Env in the environment
Declare a desired Env output to be assigned in the environment
Create or update a binding of type File in the environment
Declare a desired File output to be assigned in the environment
Create or update a binding of type GeneratorGroup in the environment
Declare a desired GeneratorGroup output to be assigned in the environment
Create or update a binding of type Generator in the environment
Declare a desired Generator output to be assigned in the environment
Create or update a binding of type GitRef in the environment
Declare a desired GitRef output to be assigned in the environment
Create or update a binding of type GitRepository in the environment
Declare a desired GitRepository output to be assigned in the environment
Create or update a binding of type HTTPState in the environment
Declare a desired HTTPState output to be assigned in the environment
Create or update a binding of type JSONValue in the environment
Declare a desired JSONValue output to be assigned in the environment
Sets the main module for this environment (the project being worked on)
Installs a module into the environment, exposing its functions to the model
Create or update a binding of type ModuleConfigClient in the environment
Declare a desired ModuleConfigClient output to be assigned in the environment
Create or update a binding of type Module in the environment
Declare a desired Module output to be assigned in the environment
Create or update a binding of type ModuleSource in the environment
Declare a desired ModuleSource output to be assigned in the environment
Create or update a binding of type PhpSdk in the environment
Declare a desired PhpSdk output to be assigned in the environment
Create or update a binding of type SearchResult in the environment
Declare a desired SearchResult output to be assigned in the environment
Create or update a binding of type SearchSubmatch in the environment
Declare a desired SearchSubmatch output to be assigned in the environment
Create or update a binding of type Secret in the environment
Declare a desired Secret output to be assigned in the environment
Create or update a binding of type Service in the environment
Declare a desired Service output to be assigned in the environment
Create or update a binding of type Socket in the environment
Declare a desired Socket output to be assigned in the environment
Create or update a binding of type Stat in the environment
Declare a desired Stat output to be assigned in the environment
Provides a string input binding to the environment
Declares a desired string output binding
Create or update a binding of type UpGroup in the environment
Declare a desired UpGroup output to be assigned in the environment
Create or update a binding of type Up in the environment
Declare a desired Up output to be assigned in the environment
Create or update a binding of type WorkspaceGit in the environment
Declare a desired WorkspaceGit output to be assigned in the environment
Create or update a binding of type Workspace in the environment
Create or update a binding of type WorkspaceMigration in the environment
Declare a desired WorkspaceMigration output to be assigned in the environment
Create or update a binding of type WorkspaceMigrationStep in the environment
Declare a desired WorkspaceMigrationStep output to be assigned in the environment
Create or update a binding of type WorkspaceModule in the environment
Declare a desired WorkspaceModule output to be assigned in the environment
Create or update a binding of type WorkspaceModuleSetting in the environment
Declare a desired WorkspaceModuleSetting output to be assigned in the environment
Declare a desired Workspace output to be assigned in the environment
Returns a new environment without any outputs
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 16
Check
check(string $name)
Return the check with the given name from the installed modules. Must match exactly one check.
at line 26
CheckGroup
checks(array|null $include = null, bool|null $noGenerate = null)
Return all checks defined by the installed modules
at line 41
Id
id()
A unique identifier for this Env.
at line 50
Binding
input(string $name)
Retrieves an input binding by name
at line 60
array
inputs()
Returns all input bindings provided to the environment
at line 69
Binding
output(string $name)
Retrieves an output binding by name
at line 79
array
outputs()
Returns all declared output bindings for the environment
at line 88
UpGroup
services(array|null $include = null)
Return all services defined by the installed modules
at line 100
Env
withAddressInput(string $name, Address $value, string $description)
Create or update a binding of type Address in the environment
at line 112
Env
withAddressOutput(string $name, string $description)
Declare a desired Address output to be assigned in the environment
at line 123
Env
withCacheVolumeInput(string $name, CacheVolume $value, string $description)
Create or update a binding of type CacheVolume in the environment
at line 135
Env
withCacheVolumeOutput(string $name, string $description)
Declare a desired CacheVolume output to be assigned in the environment
at line 146
Env
withChangesetInput(string $name, Changeset $value, string $description)
Create or update a binding of type Changeset in the environment
at line 158
Env
withChangesetOutput(string $name, string $description)
Declare a desired Changeset output to be assigned in the environment
at line 169
Env
withCheckGroupInput(string $name, CheckGroup $value, string $description)
Create or update a binding of type CheckGroup in the environment
at line 181
Env
withCheckGroupOutput(string $name, string $description)
Declare a desired CheckGroup output to be assigned in the environment
at line 192
Env
withCheckInput(string $name, Check $value, string $description)
Create or update a binding of type Check in the environment
at line 204
Env
withCheckOutput(string $name, string $description)
Declare a desired Check output to be assigned in the environment
at line 215
Env
withCloudInput(string $name, Cloud $value, string $description)
Create or update a binding of type Cloud in the environment
at line 227
Env
withCloudOutput(string $name, string $description)
Declare a desired Cloud output to be assigned in the environment
at line 238
Env
withContainerInput(string $name, Container $value, string $description)
Create or update a binding of type Container in the environment
at line 250
Env
withContainerOutput(string $name, string $description)
Declare a desired Container output to be assigned in the environment
at line 263
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.
at line 272
Env
withCurrentModuleAsSDKClientInput(string $name, CurrentModuleAsSDKClient $value, string $description)
Create or update a binding of type CurrentModuleAsSDKClient in the environment
at line 287
Env
withCurrentModuleAsSDKClientOutput(string $name, string $description)
Declare a desired CurrentModuleAsSDKClient output to be assigned in the environment
at line 298
Env
withCurrentModuleAsSDKInput(string $name, CurrentModuleAsSDK $value, string $description)
Create or update a binding of type CurrentModuleAsSDK in the environment
at line 310
Env
withCurrentModuleAsSDKModuleInput(string $name, CurrentModuleAsSDKModule $value, string $description)
Create or update a binding of type CurrentModuleAsSDKModule in the environment
at line 325
Env
withCurrentModuleAsSDKModuleOutput(string $name, string $description)
Declare a desired CurrentModuleAsSDKModule output to be assigned in the environment
at line 336
Env
withCurrentModuleAsSDKOutput(string $name, string $description)
Declare a desired CurrentModuleAsSDK output to be assigned in the environment
at line 347
Env
withDiffStatInput(string $name, DiffStat $value, string $description)
Create or update a binding of type DiffStat in the environment
at line 359
Env
withDiffStatOutput(string $name, string $description)
Declare a desired DiffStat output to be assigned in the environment
at line 370
Env
withDirectoryInput(string $name, Directory $value, string $description)
Create or update a binding of type Directory in the environment
at line 382
Env
withDirectoryOutput(string $name, string $description)
Declare a desired Directory output to be assigned in the environment
at line 393
Env
withEnvFileInput(string $name, EnvFile $value, string $description)
Create or update a binding of type EnvFile in the environment
at line 405
Env
withEnvFileOutput(string $name, string $description)
Declare a desired EnvFile output to be assigned in the environment
at line 416
Env
withEnvInput(string $name, Env $value, string $description)
Create or update a binding of type Env in the environment
at line 428
Env
withEnvOutput(string $name, string $description)
Declare a desired Env output to be assigned in the environment
at line 439
Env
withFileInput(string $name, File $value, string $description)
Create or update a binding of type File in the environment
at line 451
Env
withFileOutput(string $name, string $description)
Declare a desired File output to be assigned in the environment
at line 462
Env
withGeneratorGroupInput(string $name, GeneratorGroup $value, string $description)
Create or update a binding of type GeneratorGroup in the environment
at line 474
Env
withGeneratorGroupOutput(string $name, string $description)
Declare a desired GeneratorGroup output to be assigned in the environment
at line 485
Env
withGeneratorInput(string $name, Generator $value, string $description)
Create or update a binding of type Generator in the environment
at line 497
Env
withGeneratorOutput(string $name, string $description)
Declare a desired Generator output to be assigned in the environment
at line 508
Env
withGitRefInput(string $name, GitRef $value, string $description)
Create or update a binding of type GitRef in the environment
at line 520
Env
withGitRefOutput(string $name, string $description)
Declare a desired GitRef output to be assigned in the environment
at line 531
Env
withGitRepositoryInput(string $name, GitRepository $value, string $description)
Create or update a binding of type GitRepository in the environment
at line 543
Env
withGitRepositoryOutput(string $name, string $description)
Declare a desired GitRepository output to be assigned in the environment
at line 554
Env
withHTTPStateInput(string $name, HTTPState $value, string $description)
Create or update a binding of type HTTPState in the environment
at line 566
Env
withHTTPStateOutput(string $name, string $description)
Declare a desired HTTPState output to be assigned in the environment
at line 577
Env
withJSONValueInput(string $name, JsonValue $value, string $description)
Create or update a binding of type JSONValue in the environment
at line 589
Env
withJSONValueOutput(string $name, string $description)
Declare a desired JSONValue output to be assigned in the environment
at line 602
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.
at line 614
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.
at line 624
Env
withModuleConfigClientInput(string $name, ModuleConfigClient $value, string $description)
Create or update a binding of type ModuleConfigClient in the environment
at line 636
Env
withModuleConfigClientOutput(string $name, string $description)
Declare a desired ModuleConfigClient output to be assigned in the environment
at line 647
Env
withModuleInput(string $name, Module $value, string $description)
Create or update a binding of type Module in the environment
at line 659
Env
withModuleOutput(string $name, string $description)
Declare a desired Module output to be assigned in the environment
at line 670
Env
withModuleSourceInput(string $name, ModuleSource $value, string $description)
Create or update a binding of type ModuleSource in the environment
at line 682
Env
withModuleSourceOutput(string $name, string $description)
Declare a desired ModuleSource output to be assigned in the environment
at line 693
Env
withPhpSdkInput(string $name, PhpSdk $value, string $description)
Create or update a binding of type PhpSdk in the environment
at line 705
Env
withPhpSdkOutput(string $name, string $description)
Declare a desired PhpSdk output to be assigned in the environment
at line 716
Env
withSearchResultInput(string $name, SearchResult $value, string $description)
Create or update a binding of type SearchResult in the environment
at line 728
Env
withSearchResultOutput(string $name, string $description)
Declare a desired SearchResult output to be assigned in the environment
at line 739
Env
withSearchSubmatchInput(string $name, SearchSubmatch $value, string $description)
Create or update a binding of type SearchSubmatch in the environment
at line 751
Env
withSearchSubmatchOutput(string $name, string $description)
Declare a desired SearchSubmatch output to be assigned in the environment
at line 762
Env
withSecretInput(string $name, Secret $value, string $description)
Create or update a binding of type Secret in the environment
at line 774
Env
withSecretOutput(string $name, string $description)
Declare a desired Secret output to be assigned in the environment
at line 785
Env
withServiceInput(string $name, Service $value, string $description)
Create or update a binding of type Service in the environment
at line 797
Env
withServiceOutput(string $name, string $description)
Declare a desired Service output to be assigned in the environment
at line 808
Env
withSocketInput(string $name, Socket $value, string $description)
Create or update a binding of type Socket in the environment
at line 820
Env
withSocketOutput(string $name, string $description)
Declare a desired Socket output to be assigned in the environment
at line 831
Env
withStatInput(string $name, Stat $value, string $description)
Create or update a binding of type Stat in the environment
at line 843
Env
withStatOutput(string $name, string $description)
Declare a desired Stat output to be assigned in the environment
at line 854
Env
withStringInput(string $name, string $value, string $description)
Provides a string input binding to the environment
at line 866
Env
withStringOutput(string $name, string $description)
Declares a desired string output binding
at line 877
Env
withUpGroupInput(string $name, UpGroup $value, string $description)
Create or update a binding of type UpGroup in the environment
at line 889
Env
withUpGroupOutput(string $name, string $description)
Declare a desired UpGroup output to be assigned in the environment
at line 900
Env
withUpInput(string $name, Up $value, string $description)
Create or update a binding of type Up in the environment
at line 912
Env
withUpOutput(string $name, string $description)
Declare a desired Up output to be assigned in the environment
at line 923
Env
withWorkspace(Directory $workspace)
Returns a new environment with the provided workspace
at line 933
Env
withWorkspaceGitInput(string $name, WorkspaceGit $value, string $description)
Create or update a binding of type WorkspaceGit in the environment
at line 945
Env
withWorkspaceGitOutput(string $name, string $description)
Declare a desired WorkspaceGit output to be assigned in the environment
at line 956
Env
withWorkspaceInput(string $name, Workspace $value, string $description)
Create or update a binding of type Workspace in the environment
at line 968
Env
withWorkspaceMigrationInput(string $name, WorkspaceMigration $value, string $description)
Create or update a binding of type WorkspaceMigration in the environment
at line 980
Env
withWorkspaceMigrationOutput(string $name, string $description)
Declare a desired WorkspaceMigration output to be assigned in the environment
at line 991
Env
withWorkspaceMigrationStepInput(string $name, WorkspaceMigrationStep $value, string $description)
Create or update a binding of type WorkspaceMigrationStep in the environment
at line 1006
Env
withWorkspaceMigrationStepOutput(string $name, string $description)
Declare a desired WorkspaceMigrationStep output to be assigned in the environment
at line 1017
Env
withWorkspaceModuleInput(string $name, WorkspaceModule $value, string $description)
Create or update a binding of type WorkspaceModule in the environment
at line 1029
Env
withWorkspaceModuleOutput(string $name, string $description)
Declare a desired WorkspaceModule output to be assigned in the environment
at line 1040
Env
withWorkspaceModuleSettingInput(string $name, WorkspaceModuleSetting $value, string $description)
Create or update a binding of type WorkspaceModuleSetting in the environment
at line 1055
Env
withWorkspaceModuleSettingOutput(string $name, string $description)
Declare a desired WorkspaceModuleSetting output to be assigned in the environment
at line 1066
Env
withWorkspaceOutput(string $name, string $description)
Declare a desired Workspace output to be assigned in the environment
at line 1077
Env
withoutOutputs()
Returns a new environment without any outputs
at line 1083
Directory
workspace()
No description