Back to Dagger

Client

docs/static/reference/php/Dagger/Client.html

0.21.038.7 KB
Original Source

Client

class Client extends AbstractClient implements IdAble

The root of the DAG.

Properties

| protected AbstractClient | $client | | from AbstractClient | | protected Client | $graphQlClient | | from AbstractClient |

Methods

__construct(Client $clientOrConnection, QueryBuilderChain $queryBuilderChain = new QueryBuilderChain())

No description

from AbstractClient

Results

runQuery(Query $query)

No description

from AbstractClient

null|array|string|int|float|bool

queryLeaf(Query $query, string $leafKey)

No description

from AbstractClient

Address

address(string $value)

initialize an address to load directories, containers, secrets or other object types.

CacheVolume

cacheVolume(string $key, Directory|null $source = null, CacheSharingMode|null $sharing = null, string|null $owner = '')

Constructs a cache volume for a given cache key.

Changeset

changeset()

Creates an empty changeset

Cloud

cloud()

Dagger Cloud configuration and state

GeneratedCode

codegen(ModuleSource $modSource, File $introspectionJson)

No description

Container

codegenBase(ModuleSource $modSource, File $introspectionJson)

No description

Container

container(Platform|null $platform = null)

Creates a scratch container, with no image or metadata.

Env

currentEnv()

Returns the current environment

FunctionCall

currentFunctionCall()

The FunctionCall context that the SDK caller is currently executing in.

CurrentModule

currentModule()

The module currently being served in the session, if any.

array

currentTypeDefs(bool|null $returnAllTypes = false, bool|null $hideCore = null)

The TypeDef representations of the objects currently being served in the session.

Workspace

currentWorkspace()

Detect and return the current workspace.

Platform

defaultPlatform()

The default platform of the engine.

Directory

directory()

Creates an empty directory.

Engine

engine()

The Dagger engine container configuration and state

Env

env(bool|null $privileged = false, bool|null $writable = false)

Initializes a new environment

EnvFile

envFile(bool|null $expand = null)

Initialize an environment file

Error

error(string $message)

Create a new error.

File

file(string $name, string $contents, int|null $permissions = 420)

Creates a file with the specified contents.

Function_

function(string $name, TypeDef $returnType)

Creates a function.

GeneratedCode

generatedCode(Directory $code)

Create a code generation result, given a directory containing the generated code.

GitRepository

git(string $url, bool|null $keepGitDir = true, string|null $sshKnownHosts = '', Socket|null $sshAuthSocket = null, string|null $httpAuthUsername = '', Secret|null $httpAuthToken = null, Secret|null $httpAuthHeader = null, Service|null $experimentalServiceHost = null)

Queries a Git repository.

Host

host()

Queries the host environment.

File

http(string $url, string|null $name = null, int|null $permissions = null, string|null $checksum = null, Secret|null $authHeader = null, Service|null $experimentalServiceHost = null)

Returns a file containing an http remote url content.

AbstractId

id()

A unique identifier for this Query.

JsonValue

json()

Initialize a JSON value

LLM

llm(string|null $model = null, int|null $maxAPICalls = null)

Initialize a Large Language Model (LLM)

Address

loadAddressFromID(Address $id)

Load a Address from its ID.

Binding

loadBindingFromID(Binding $id)

Load a Binding from its ID.

CacheVolume

loadCacheVolumeFromID(CacheVolume $id)

Load a CacheVolume from its ID.

Changeset

loadChangesetFromID(Changeset $id)

Load a Changeset from its ID.

Check

loadCheckFromID(Check $id)

Load a Check from its ID.

CheckGroup

loadCheckGroupFromID(CheckGroup $id)

Load a CheckGroup from its ID.

ClientFilesyncMirror

loadClientFilesyncMirrorFromID(ClientFilesyncMirror $id)

Load a ClientFilesyncMirror from its ID.

Cloud

loadCloudFromID(Cloud $id)

Load a Cloud from its ID.

Container

loadContainerFromID(Container $id)

Load a Container from its ID.

CurrentModule

loadCurrentModuleFromID(CurrentModule $id)

Load a CurrentModule from its ID.

DiffStat

loadDiffStatFromID(DiffStat $id)

Load a DiffStat from its ID.

Directory

loadDirectoryFromID(Directory $id)

Load a Directory from its ID.

EngineCacheEntry

loadEngineCacheEntryFromID(EngineCacheEntry $id)

Load a EngineCacheEntry from its ID.

EngineCacheEntrySet

loadEngineCacheEntrySetFromID(EngineCacheEntrySet $id)

Load a EngineCacheEntrySet from its ID.

EngineCache

loadEngineCacheFromID(EngineCache $id)

Load a EngineCache from its ID.

Engine

loadEngineFromID(Engine $id)

Load a Engine from its ID.

EnumTypeDef

loadEnumTypeDefFromID(EnumTypeDef $id)

Load a EnumTypeDef from its ID.

EnumValueTypeDef

loadEnumValueTypeDefFromID(EnumValueTypeDef $id)

Load a EnumValueTypeDef from its ID.

EnvFile

loadEnvFileFromID(EnvFile $id)

Load a EnvFile from its ID.

Env

loadEnvFromID(Env $id)

Load a Env from its ID.

EnvVariable

loadEnvVariableFromID(EnvVariable $id)

Load a EnvVariable from its ID.

Error

loadErrorFromID(Error $id)

Load a Error from its ID.

ErrorValue

loadErrorValueFromID(ErrorValue $id)

Load a ErrorValue from its ID.

FieldTypeDef

loadFieldTypeDefFromID(FieldTypeDef $id)

Load a FieldTypeDef from its ID.

File

loadFileFromID(File $id)

Load a File from its ID.

FunctionArg

loadFunctionArgFromID(FunctionArg $id)

Load a FunctionArg from its ID.

FunctionCallArgValue

loadFunctionCallArgValueFromID(FunctionCallArgValue $id)

Load a FunctionCallArgValue from its ID.

FunctionCall

loadFunctionCallFromID(FunctionCall $id)

Load a FunctionCall from its ID.

Function_

loadFunctionFromID(Function_ $id)

Load a Function from its ID.

GeneratedCode

loadGeneratedCodeFromID(GeneratedCode $id)

Load a GeneratedCode from its ID.

Generator

loadGeneratorFromID(Generator $id)

Load a Generator from its ID.

GeneratorGroup

loadGeneratorGroupFromID(GeneratorGroup $id)

Load a GeneratorGroup from its ID.

GitRef

loadGitRefFromID(GitRef $id)

Load a GitRef from its ID.

GitRepository

loadGitRepositoryFromID(GitRepository $id)

Load a GitRepository from its ID.

HTTPState

loadHTTPStateFromID(HTTPState $id)

Load a HTTPState from its ID.

HealthcheckConfig

loadHealthcheckConfigFromID(HealthcheckConfig $id)

Load a HealthcheckConfig from its ID.

Host

loadHostFromID(Host $id)

Load a Host from its ID.

InputTypeDef

loadInputTypeDefFromID(InputTypeDef $id)

Load a InputTypeDef from its ID.

InterfaceTypeDef

loadInterfaceTypeDefFromID(InterfaceTypeDef $id)

Load a InterfaceTypeDef from its ID.

JsonValue

loadJSONValueFromID(JsonValue $id)

Load a JSONValue from its ID.

LLM

loadLLMFromID(LLM $id)

Load a LLM from its ID.

LLMTokenUsage

loadLLMTokenUsageFromID(LLMTokenUsage $id)

Load a LLMTokenUsage from its ID.

Label

loadLabelFromID(Label $id)

Load a Label from its ID.

ListTypeDef

loadListTypeDefFromID(ListTypeDef $id)

Load a ListTypeDef from its ID.

ModuleConfigClient

loadModuleConfigClientFromID(ModuleConfigClient $id)

Load a ModuleConfigClient from its ID.

Module

loadModuleFromID(Module $id)

Load a Module from its ID.

ModuleSource

loadModuleSourceFromID(ModuleSource $id)

Load a ModuleSource from its ID.

ObjectTypeDef

loadObjectTypeDefFromID(ObjectTypeDef $id)

Load a ObjectTypeDef from its ID.

PhpSdk

loadPhpSdkFromID(PhpSdk $id)

Load a PhpSdk from its ID.

Port

loadPortFromID(Port $id)

Load a Port from its ID.

Client

loadQueryFromID(Query $id)

Load a Query from its ID.

RemoteGitMirror

loadRemoteGitMirrorFromID(RemoteGitMirror $id)

Load a RemoteGitMirror from its ID.

SDKConfig

loadSDKConfigFromID(SDKConfig $id)

Load a SDKConfig from its ID.

ScalarTypeDef

loadScalarTypeDefFromID(ScalarTypeDef $id)

Load a ScalarTypeDef from its ID.

SearchResult

loadSearchResultFromID(SearchResult $id)

Load a SearchResult from its ID.

SearchSubmatch

loadSearchSubmatchFromID(SearchSubmatch $id)

Load a SearchSubmatch from its ID.

Secret

loadSecretFromID(Secret $id)

Load a Secret from its ID.

Service

loadServiceFromID(Service $id)

Load a Service from its ID.

Socket

loadSocketFromID(Socket $id)

Load a Socket from its ID.

SourceMap

loadSourceMapFromID(SourceMap $id)

Load a SourceMap from its ID.

Stat

loadStatFromID(Stat $id)

Load a Stat from its ID.

Terminal

loadTerminalFromID(Terminal $id)

Load a Terminal from its ID.

TypeDef

loadTypeDefFromID(TypeDef $id)

Load a TypeDef from its ID.

Up

loadUpFromID(Up $id)

Load a Up from its ID.

UpGroup

loadUpGroupFromID(UpGroup $id)

Load a UpGroup from its ID.

Workspace

loadWorkspaceFromID(Workspace $id)

Load a Workspace from its ID.

Module

module()

Create a new module.

Container

moduleRuntime(ModuleSource $modSource, File $introspectionJson)

No description

ModuleSource

moduleSource(string $refString, string|null $refPin = '', bool|null $disableFindUp = false, bool|null $allowNotExists = false, ModuleSourceKind|null $requireKind = null)

Create a new module source instance from a source ref string

Secret

secret(string $uri, string|null $cacheKey = null)

Creates a new secret.

Secret

setSecret(string $name, string $plaintext)

Sets a secret given a user defined name to its plaintext and returns the secret.

Directory

sourceDir()

No description

SourceMap

sourceMap(string $filename, int $line, int $column)

Creates source map metadata.

TypeDef

typeDef()

Create a new TypeDef.

string

version()

Get the current Dagger Engine version.

Client

with(Directory|null $sdkSourceDir = null)

Configure the php-sdk constructor arguments.

Details

in AbstractClient at line 20 __construct(Client $clientOrConnection, QueryBuilderChain $queryBuilderChain = new QueryBuilderChain())

No description

Parameters

| Client | $clientOrConnection | | | QueryBuilderChain | $queryBuilderChain | |

in AbstractClient at line 33 Results runQuery(Query $query)

No description

Parameters

| Query | $query | |

Return Value

| Results | |

in AbstractClient at line 38 null|array|string|int|float|bool queryLeaf(Query $query, string $leafKey)

No description

Parameters

| Query | $query | | | string | $leafKey | |

Return Value

| null|array|string|int|float|bool | |

at line 19 Address address(string $value)

initialize an address to load directories, containers, secrets or other object types.

Parameters

| string | $value | |

Return Value

| Address | |

at line 29 CacheVolume cacheVolume(string $key, Directory|null $source = null, CacheSharingMode|null $sharing = null, string|null $owner = '')

Constructs a cache volume for a given cache key.

Parameters

| string | $key | | | Directory|null | $source | | | CacheSharingMode|null | $sharing | | | string|null | $owner | |

Return Value

| CacheVolume | |

at line 52 Changeset changeset()

Creates an empty changeset

Return Value

| Changeset | |

at line 61 Cloud cloud()

Dagger Cloud configuration and state

Return Value

| Cloud | |

at line 67 GeneratedCode codegen(ModuleSource $modSource, File $introspectionJson)

No description

Parameters

| ModuleSource | $modSource | | | File | $introspectionJson | |

Return Value

| GeneratedCode | |

at line 75 Container codegenBase(ModuleSource $modSource, File $introspectionJson)

No description

Parameters

| ModuleSource | $modSource | | | File | $introspectionJson | |

Return Value

| Container | |

at line 88 Container container(Platform|null $platform = null)

Creates a scratch container, with no image or metadata.

To pull an image, follow up with the "from" function.

Parameters

| Platform|null | $platform | |

Return Value

| Container | |

at line 104 Env currentEnv()

Returns the current environment

When called from a function invoked via an LLM tool call, this will be the LLM's current environment, including any modifications made through calling tools. Env values returned by functions become the new environment for subsequent calls, and Changeset values returned by functions are applied to the environment's workspace.

When called from a module function outside of an LLM, this returns an Env with the current module installed, and with the current module's source directory as its workspace.

Return Value

| Env | |

at line 115 FunctionCall currentFunctionCall()

The FunctionCall context that the SDK caller is currently executing in.

If the caller is not currently executing in a function, this will return an error.

Return Value

| FunctionCall | |

at line 124 CurrentModule currentModule()

The module currently being served in the session, if any.

Return Value

| CurrentModule | |

at line 133 array currentTypeDefs(bool|null $returnAllTypes = false, bool|null $hideCore = null)

The TypeDef representations of the objects currently being served in the session.

Parameters

| bool|null | $returnAllTypes | | | bool|null | $hideCore | |

Return Value

| array | |

at line 148 Workspace currentWorkspace()

Detect and return the current workspace.

Return Value

| Workspace | |

at line 157 Platform defaultPlatform()

The default platform of the engine.

Return Value

| Platform | |

at line 166 Directory directory()

Creates an empty directory.

Return Value

| Directory | |

at line 175 Engine engine()

The Dagger engine container configuration and state

Return Value

| Engine | |

at line 184 Env env(bool|null $privileged = false, bool|null $writable = false)

Initializes a new environment

Parameters

| bool|null | $privileged | | | bool|null | $writable | |

Return Value

| Env | |

at line 199 EnvFile envFile(bool|null $expand = null)

Initialize an environment file

Parameters

| bool|null | $expand | |

Return Value

| EnvFile | |

at line 211 Error error(string $message)

Create a new error.

Parameters

| string | $message | |

Return Value

| Error | |

at line 221 File file(string $name, string $contents, int|null $permissions = 420)

Creates a file with the specified contents.

Parameters

| string | $name | | | string | $contents | | | int|null | $permissions | |

Return Value

| File | |

at line 235 Function_ function(string $name, TypeDef $returnType)

Creates a function.

Parameters

| string | $name | | | TypeDef | $returnType | |

Return Value

| Function_ | |

at line 246 GeneratedCode generatedCode(Directory $code)

Create a code generation result, given a directory containing the generated code.

Parameters

| Directory | $code | |

Return Value

| GeneratedCode | |

at line 256 GitRepository git(string $url, bool|null $keepGitDir = true, string|null $sshKnownHosts = '', Socket|null $sshAuthSocket = null, string|null $httpAuthUsername = '', Secret|null $httpAuthToken = null, Secret|null $httpAuthHeader = null, Service|null $experimentalServiceHost = null)

Queries a Git repository.

Parameters

| string | $url | | | bool|null | $keepGitDir | | | string|null | $sshKnownHosts | | | Socket|null | $sshAuthSocket | | | string|null | $httpAuthUsername | | | Secret|null | $httpAuthToken | | | Secret|null | $httpAuthHeader | | | Service|null | $experimentalServiceHost | |

Return Value

| GitRepository | |

at line 295 Host host()

Queries the host environment.

Return Value

| Host | |

at line 304 File http(string $url, string|null $name = null, int|null $permissions = null, string|null $checksum = null, Secret|null $authHeader = null, Service|null $experimentalServiceHost = null)

Returns a file containing an http remote url content.

Parameters

| string | $url | | | string|null | $name | | | int|null | $permissions | | | string|null | $checksum | | | Secret|null | $authHeader | | | Service|null | $experimentalServiceHost | |

Return Value

| File | |

at line 335 AbstractId id()

A unique identifier for this Query.

Return Value

| AbstractId | |

at line 344 JsonValue json()

Initialize a JSON value

Return Value

| JsonValue | |

at line 353 LLM llm(string|null $model = null, int|null $maxAPICalls = null)

Initialize a Large Language Model (LLM)

Parameters

| string|null | $model | | | int|null | $maxAPICalls | |

Return Value

| LLM | |

at line 368 Address loadAddressFromID(Address $id)

Load a Address from its ID.

Parameters

| Address | $id | |

Return Value

| Address | |

at line 378 Binding loadBindingFromID(Binding $id)

Load a Binding from its ID.

Parameters

| Binding | $id | |

Return Value

| Binding | |

at line 388 CacheVolume loadCacheVolumeFromID(CacheVolume $id)

Load a CacheVolume from its ID.

Parameters

| CacheVolume | $id | |

Return Value

| CacheVolume | |

at line 398 Changeset loadChangesetFromID(Changeset $id)

Load a Changeset from its ID.

Parameters

| Changeset | $id | |

Return Value

| Changeset | |

at line 408 Check loadCheckFromID(Check $id)

Load a Check from its ID.

Parameters

| Check | $id | |

Return Value

| Check | |

at line 418 CheckGroup loadCheckGroupFromID(CheckGroup $id)

Load a CheckGroup from its ID.

Parameters

| CheckGroup | $id | |

Return Value

| CheckGroup | |

at line 428 ClientFilesyncMirror loadClientFilesyncMirrorFromID(ClientFilesyncMirror $id)

Load a ClientFilesyncMirror from its ID.

Parameters

| ClientFilesyncMirror | $id | |

Return Value

| ClientFilesyncMirror | |

at line 439 Cloud loadCloudFromID(Cloud $id)

Load a Cloud from its ID.

Parameters

| Cloud | $id | |

Return Value

| Cloud | |

at line 449 Container loadContainerFromID(Container $id)

Load a Container from its ID.

Parameters

| Container | $id | |

Return Value

| Container | |

at line 459 CurrentModule loadCurrentModuleFromID(CurrentModule $id)

Load a CurrentModule from its ID.

Parameters

| CurrentModule | $id | |

Return Value

| CurrentModule | |

at line 469 DiffStat loadDiffStatFromID(DiffStat $id)

Load a DiffStat from its ID.

Parameters

| DiffStat | $id | |

Return Value

| DiffStat | |

at line 479 Directory loadDirectoryFromID(Directory $id)

Load a Directory from its ID.

Parameters

| Directory | $id | |

Return Value

| Directory | |

at line 489 EngineCacheEntry loadEngineCacheEntryFromID(EngineCacheEntry $id)

Load a EngineCacheEntry from its ID.

Parameters

| EngineCacheEntry | $id | |

Return Value

| EngineCacheEntry | |

at line 499 EngineCacheEntrySet loadEngineCacheEntrySetFromID(EngineCacheEntrySet $id)

Load a EngineCacheEntrySet from its ID.

Parameters

| EngineCacheEntrySet | $id | |

Return Value

| EngineCacheEntrySet | |

at line 509 EngineCache loadEngineCacheFromID(EngineCache $id)

Load a EngineCache from its ID.

Parameters

| EngineCache | $id | |

Return Value

| EngineCache | |

at line 519 Engine loadEngineFromID(Engine $id)

Load a Engine from its ID.

Parameters

| Engine | $id | |

Return Value

| Engine | |

at line 529 EnumTypeDef loadEnumTypeDefFromID(EnumTypeDef $id)

Load a EnumTypeDef from its ID.

Parameters

| EnumTypeDef | $id | |

Return Value

| EnumTypeDef | |

at line 539 EnumValueTypeDef loadEnumValueTypeDefFromID(EnumValueTypeDef $id)

Load a EnumValueTypeDef from its ID.

Parameters

| EnumValueTypeDef | $id | |

Return Value

| EnumValueTypeDef | |

at line 549 EnvFile loadEnvFileFromID(EnvFile $id)

Load a EnvFile from its ID.

Parameters

| EnvFile | $id | |

Return Value

| EnvFile | |

at line 559 Env loadEnvFromID(Env $id)

Load a Env from its ID.

Parameters

| Env | $id | |

Return Value

| Env | |

at line 569 EnvVariable loadEnvVariableFromID(EnvVariable $id)

Load a EnvVariable from its ID.

Parameters

| EnvVariable | $id | |

Return Value

| EnvVariable | |

at line 579 Error loadErrorFromID(Error $id)

Load a Error from its ID.

Parameters

| Error | $id | |

Return Value

| Error | |

at line 589 ErrorValue loadErrorValueFromID(ErrorValue $id)

Load a ErrorValue from its ID.

Parameters

| ErrorValue | $id | |

Return Value

| ErrorValue | |

at line 599 FieldTypeDef loadFieldTypeDefFromID(FieldTypeDef $id)

Load a FieldTypeDef from its ID.

Parameters

| FieldTypeDef | $id | |

Return Value

| FieldTypeDef | |

at line 609 File loadFileFromID(File $id)

Load a File from its ID.

Parameters

| File | $id | |

Return Value

| File | |

at line 619 FunctionArg loadFunctionArgFromID(FunctionArg $id)

Load a FunctionArg from its ID.

Parameters

| FunctionArg | $id | |

Return Value

| FunctionArg | |

at line 629 FunctionCallArgValue loadFunctionCallArgValueFromID(FunctionCallArgValue $id)

Load a FunctionCallArgValue from its ID.

Parameters

| FunctionCallArgValue | $id | |

Return Value

| FunctionCallArgValue | |

at line 640 FunctionCall loadFunctionCallFromID(FunctionCall $id)

Load a FunctionCall from its ID.

Parameters

| FunctionCall | $id | |

Return Value

| FunctionCall | |

at line 650 Function_ loadFunctionFromID(Function_ $id)

Load a Function from its ID.

Parameters

| Function_ | $id | |

Return Value

| Function_ | |

at line 660 GeneratedCode loadGeneratedCodeFromID(GeneratedCode $id)

Load a GeneratedCode from its ID.

Parameters

| GeneratedCode | $id | |

Return Value

| GeneratedCode | |

at line 670 Generator loadGeneratorFromID(Generator $id)

Load a Generator from its ID.

Parameters

| Generator | $id | |

Return Value

| Generator | |

at line 680 GeneratorGroup loadGeneratorGroupFromID(GeneratorGroup $id)

Load a GeneratorGroup from its ID.

Parameters

| GeneratorGroup | $id | |

Return Value

| GeneratorGroup | |

at line 690 GitRef loadGitRefFromID(GitRef $id)

Load a GitRef from its ID.

Parameters

| GitRef | $id | |

Return Value

| GitRef | |

at line 700 GitRepository loadGitRepositoryFromID(GitRepository $id)

Load a GitRepository from its ID.

Parameters

| GitRepository | $id | |

Return Value

| GitRepository | |

at line 710 HTTPState loadHTTPStateFromID(HTTPState $id)

Load a HTTPState from its ID.

Parameters

| HTTPState | $id | |

Return Value

| HTTPState | |

at line 720 HealthcheckConfig loadHealthcheckConfigFromID(HealthcheckConfig $id)

Load a HealthcheckConfig from its ID.

Parameters

| HealthcheckConfig | $id | |

Return Value

| HealthcheckConfig | |

at line 730 Host loadHostFromID(Host $id)

Load a Host from its ID.

Parameters

| Host | $id | |

Return Value

| Host | |

at line 740 InputTypeDef loadInputTypeDefFromID(InputTypeDef $id)

Load a InputTypeDef from its ID.

Parameters

| InputTypeDef | $id | |

Return Value

| InputTypeDef | |

at line 750 InterfaceTypeDef loadInterfaceTypeDefFromID(InterfaceTypeDef $id)

Load a InterfaceTypeDef from its ID.

Parameters

| InterfaceTypeDef | $id | |

Return Value

| InterfaceTypeDef | |

at line 760 JsonValue loadJSONValueFromID(JsonValue $id)

Load a JSONValue from its ID.

Parameters

| JsonValue | $id | |

Return Value

| JsonValue | |

at line 770 LLM loadLLMFromID(LLM $id)

Load a LLM from its ID.

Parameters

| LLM | $id | |

Return Value

| LLM | |

at line 780 LLMTokenUsage loadLLMTokenUsageFromID(LLMTokenUsage $id)

Load a LLMTokenUsage from its ID.

Parameters

| LLMTokenUsage | $id | |

Return Value

| LLMTokenUsage | |

at line 790 Label loadLabelFromID(Label $id)

Load a Label from its ID.

Parameters

| Label | $id | |

Return Value

| Label | |

at line 800 ListTypeDef loadListTypeDefFromID(ListTypeDef $id)

Load a ListTypeDef from its ID.

Parameters

| ListTypeDef | $id | |

Return Value

| ListTypeDef | |

at line 810 ModuleConfigClient loadModuleConfigClientFromID(ModuleConfigClient $id)

Load a ModuleConfigClient from its ID.

Parameters

| ModuleConfigClient | $id | |

Return Value

| ModuleConfigClient | |

at line 820 Module loadModuleFromID(Module $id)

Load a Module from its ID.

Parameters

| Module | $id | |

Return Value

| Module | |

at line 830 ModuleSource loadModuleSourceFromID(ModuleSource $id)

Load a ModuleSource from its ID.

Parameters

| ModuleSource | $id | |

Return Value

| ModuleSource | |

at line 840 ObjectTypeDef loadObjectTypeDefFromID(ObjectTypeDef $id)

Load a ObjectTypeDef from its ID.

Parameters

| ObjectTypeDef | $id | |

Return Value

| ObjectTypeDef | |

at line 850 PhpSdk loadPhpSdkFromID(PhpSdk $id)

Load a PhpSdk from its ID.

Parameters

| PhpSdk | $id | |

Return Value

| PhpSdk | |

at line 860 Port loadPortFromID(Port $id)

Load a Port from its ID.

Parameters

| Port | $id | |

Return Value

| Port | |

at line 870 Client loadQueryFromID(Query $id)

Load a Query from its ID.

Parameters

| Query | $id | |

Return Value

| Client | |

at line 880 RemoteGitMirror loadRemoteGitMirrorFromID(RemoteGitMirror $id)

Load a RemoteGitMirror from its ID.

Parameters

| RemoteGitMirror | $id | |

Return Value

| RemoteGitMirror | |

at line 890 SDKConfig loadSDKConfigFromID(SDKConfig $id)

Load a SDKConfig from its ID.

Parameters

| SDKConfig | $id | |

Return Value

| SDKConfig | |

at line 900 ScalarTypeDef loadScalarTypeDefFromID(ScalarTypeDef $id)

Load a ScalarTypeDef from its ID.

Parameters

| ScalarTypeDef | $id | |

Return Value

| ScalarTypeDef | |

at line 910 SearchResult loadSearchResultFromID(SearchResult $id)

Load a SearchResult from its ID.

Parameters

| SearchResult | $id | |

Return Value

| SearchResult | |

at line 920 SearchSubmatch loadSearchSubmatchFromID(SearchSubmatch $id)

Load a SearchSubmatch from its ID.

Parameters

| SearchSubmatch | $id | |

Return Value

| SearchSubmatch | |

at line 930 Secret loadSecretFromID(Secret $id)

Load a Secret from its ID.

Parameters

| Secret | $id | |

Return Value

| Secret | |

at line 940 Service loadServiceFromID(Service $id)

Load a Service from its ID.

Parameters

| Service | $id | |

Return Value

| Service | |

at line 950 Socket loadSocketFromID(Socket $id)

Load a Socket from its ID.

Parameters

| Socket | $id | |

Return Value

| Socket | |

at line 960 SourceMap loadSourceMapFromID(SourceMap $id)

Load a SourceMap from its ID.

Parameters

| SourceMap | $id | |

Return Value

| SourceMap | |

at line 970 Stat loadStatFromID(Stat $id)

Load a Stat from its ID.

Parameters

| Stat | $id | |

Return Value

| Stat | |

at line 980 Terminal loadTerminalFromID(Terminal $id)

Load a Terminal from its ID.

Parameters

| Terminal | $id | |

Return Value

| Terminal | |

at line 990 TypeDef loadTypeDefFromID(TypeDef $id)

Load a TypeDef from its ID.

Parameters

| TypeDef | $id | |

Return Value

| TypeDef | |

at line 1000 Up loadUpFromID(Up $id)

Load a Up from its ID.

Parameters

| Up | $id | |

Return Value

| Up | |

at line 1010 UpGroup loadUpGroupFromID(UpGroup $id)

Load a UpGroup from its ID.

Parameters

| UpGroup | $id | |

Return Value

| UpGroup | |

at line 1020 Workspace loadWorkspaceFromID(Workspace $id)

Load a Workspace from its ID.

Parameters

| Workspace | $id | |

Return Value

| Workspace | |

at line 1030 Module module()

Create a new module.

Return Value

| Module | |

at line 1036 Container moduleRuntime(ModuleSource $modSource, File $introspectionJson)

No description

Parameters

| ModuleSource | $modSource | | | File | $introspectionJson | |

Return Value

| Container | |

at line 1047 ModuleSource moduleSource(string $refString, string|null $refPin = '', bool|null $disableFindUp = false, bool|null $allowNotExists = false, ModuleSourceKind|null $requireKind = null)

Create a new module source instance from a source ref string

Parameters

| string | $refString | | | string|null | $refPin | | | bool|null | $disableFindUp | | | bool|null | $allowNotExists | | | ModuleSourceKind|null | $requireKind | |

Return Value

| ModuleSource | |

at line 1074 Secret secret(string $uri, string|null $cacheKey = null)

Creates a new secret.

Parameters

| string | $uri | | | string|null | $cacheKey | |

Return Value

| Secret | |

at line 1089 Secret setSecret(string $name, string $plaintext)

Sets a secret given a user defined name to its plaintext and returns the secret.

The plaintext value is limited to a size of 128000 bytes.

Parameters

| string | $name | | | string | $plaintext | |

Return Value

| Secret | |

at line 1097 Directory sourceDir()

No description

Return Value

| Directory | |

at line 1106 SourceMap sourceMap(string $filename, int $line, int $column)

Creates source map metadata.

Parameters

| string | $filename | | | int | $line | | | int | $column | |

Return Value

| SourceMap | |

at line 1118 TypeDef typeDef()

Create a new TypeDef.

Return Value

| TypeDef | |

at line 1127 string version()

Get the current Dagger Engine version.

Return Value

| string | |

at line 1136 Client with(Directory|null $sdkSourceDir = null)

Configure the php-sdk constructor arguments.

Parameters

| Directory|null | $sdkSourceDir | |

Return Value

| Client | |

Generated by Doctum, a API Documentation generator and fork of Sami.