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

Client

class Client extends AbstractClient implements IdAble, Node

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
object
loadObjectFromId(string $className, Id $id)

Load an object by its ID using node(id:) with an inline fragment.

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.

Id
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(AddressId $id)

Load a Address from its ID.

Binding
loadBindingFromID(BindingId $id)

Load a Binding from its ID.

CacheVolume
loadCacheVolumeFromID(CacheVolumeId $id)

Load a CacheVolume from its ID.

Changeset
loadChangesetFromID(ChangesetId $id)

Load a Changeset from its ID.

Check
loadCheckFromID(CheckId $id)

Load a Check from its ID.

CheckGroup
loadCheckGroupFromID(CheckGroupId $id)

Load a CheckGroup from its ID.

ClientFilesyncMirror
loadClientFilesyncMirrorFromID(ClientFilesyncMirrorId $id)

Load a ClientFilesyncMirror from its ID.

Cloud
loadCloudFromID(CloudId $id)

Load a Cloud from its ID.

Container
loadContainerFromID(ContainerId $id)

Load a Container from its ID.

CurrentModule
loadCurrentModuleFromID(CurrentModuleId $id)

Load a CurrentModule from its ID.

DiffStat
loadDiffStatFromID(DiffStatId $id)

Load a DiffStat from its ID.

Directory
loadDirectoryFromID(DirectoryId $id)

Load a Directory from its ID.

EngineCacheEntry
loadEngineCacheEntryFromID(EngineCacheEntryId $id)

Load a EngineCacheEntry from its ID.

EngineCacheEntrySet
loadEngineCacheEntrySetFromID(EngineCacheEntrySetId $id)

Load a EngineCacheEntrySet from its ID.

EngineCache
loadEngineCacheFromID(EngineCacheId $id)

Load a EngineCache from its ID.

Engine
loadEngineFromID(EngineId $id)

Load a Engine from its ID.

EnumTypeDef
loadEnumTypeDefFromID(EnumTypeDefId $id)

Load a EnumTypeDef from its ID.

EnumValueTypeDef
loadEnumValueTypeDefFromID(EnumValueTypeDefId $id)

Load a EnumValueTypeDef from its ID.

EnvFile
loadEnvFileFromID(EnvFileId $id)

Load a EnvFile from its ID.

Env
loadEnvFromID(EnvId $id)

Load a Env from its ID.

EnvVariable
loadEnvVariableFromID(EnvVariableId $id)

Load a EnvVariable from its ID.

Error
loadErrorFromID(ErrorId $id)

Load a Error from its ID.

ErrorValue
loadErrorValueFromID(ErrorValueId $id)

Load a ErrorValue from its ID.

Exportable
loadExportableFromID(ExportableId $id)

Load a Exportable from its ID.

FieldTypeDef
loadFieldTypeDefFromID(FieldTypeDefId $id)

Load a FieldTypeDef from its ID.

File
loadFileFromID(FileId $id)

Load a File from its ID.

FunctionArg
loadFunctionArgFromID(FunctionArgId $id)

Load a FunctionArg from its ID.

FunctionCallArgValue
loadFunctionCallArgValueFromID(FunctionCallArgValueId $id)

Load a FunctionCallArgValue from its ID.

FunctionCall
loadFunctionCallFromID(FunctionCallId $id)

Load a FunctionCall from its ID.

Function_
loadFunctionFromID(FunctionId $id)

Load a Function from its ID.

GeneratedCode
loadGeneratedCodeFromID(GeneratedCodeId $id)

Load a GeneratedCode from its ID.

Generator
loadGeneratorFromID(GeneratorId $id)

Load a Generator from its ID.

GeneratorGroup
loadGeneratorGroupFromID(GeneratorGroupId $id)

Load a GeneratorGroup from its ID.

GitRef
loadGitRefFromID(GitRefId $id)

Load a GitRef from its ID.

GitRepository
loadGitRepositoryFromID(GitRepositoryId $id)

Load a GitRepository from its ID.

HTTPState
loadHTTPStateFromID(HTTPStateId $id)

Load a HTTPState from its ID.

HealthcheckConfig
loadHealthcheckConfigFromID(HealthcheckConfigId $id)

Load a HealthcheckConfig from its ID.

Host
loadHostFromID(HostId $id)

Load a Host from its ID.

InputTypeDef
loadInputTypeDefFromID(InputTypeDefId $id)

Load a InputTypeDef from its ID.

InterfaceTypeDef
loadInterfaceTypeDefFromID(InterfaceTypeDefId $id)

Load a InterfaceTypeDef from its ID.

JsonValue
loadJSONValueFromID(JsonValueId $id)

Load a JSONValue from its ID.

LLM
loadLLMFromID(LLMId $id)

Load a LLM from its ID.

LLMTokenUsage
loadLLMTokenUsageFromID(LLMTokenUsageId $id)

Load a LLMTokenUsage from its ID.

Label
loadLabelFromID(LabelId $id)

Load a Label from its ID.

ListTypeDef
loadListTypeDefFromID(ListTypeDefId $id)

Load a ListTypeDef from its ID.

ModuleConfigClient
loadModuleConfigClientFromID(ModuleConfigClientId $id)

Load a ModuleConfigClient from its ID.

Module
loadModuleFromID(ModuleId $id)

Load a Module from its ID.

ModuleSource
loadModuleSourceFromID(ModuleSourceId $id)

Load a ModuleSource from its ID.

ObjectTypeDef
loadObjectTypeDefFromID(ObjectTypeDefId $id)

Load a ObjectTypeDef from its ID.

PhpSdk
loadPhpSdkFromID(PhpSdkId $id)

Load a PhpSdk from its ID.

Port
loadPortFromID(PortId $id)

Load a Port from its ID.

RemoteGitMirror
loadRemoteGitMirrorFromID(RemoteGitMirrorId $id)

Load a RemoteGitMirror from its ID.

SDKConfig
loadSDKConfigFromID(SDKConfigId $id)

Load a SDKConfig from its ID.

ScalarTypeDef
loadScalarTypeDefFromID(ScalarTypeDefId $id)

Load a ScalarTypeDef from its ID.

SearchResult
loadSearchResultFromID(SearchResultId $id)

Load a SearchResult from its ID.

SearchSubmatch
loadSearchSubmatchFromID(SearchSubmatchId $id)

Load a SearchSubmatch from its ID.

Secret
loadSecretFromID(SecretId $id)

Load a Secret from its ID.

Service
loadServiceFromID(ServiceId $id)

Load a Service from its ID.

Socket
loadSocketFromID(SocketId $id)

Load a Socket from its ID.

SourceMap
loadSourceMapFromID(SourceMapId $id)

Load a SourceMap from its ID.

Stat
loadStatFromID(StatId $id)

Load a Stat from its ID.

Syncer
loadSyncerFromID(SyncerId $id)

Load a Syncer from its ID.

Terminal
loadTerminalFromID(TerminalId $id)

Load a Terminal from its ID.

TypeDef
loadTypeDefFromID(TypeDefId $id)

Load a TypeDef from its ID.

Up
loadUpFromID(UpId $id)

Load a Up from its ID.

UpGroup
loadUpGroupFromID(UpGroupId $id)

Load a UpGroup from its ID.

Workspace
loadWorkspaceFromID(WorkspaceId $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

Node
node(Id $id)

Load any object by its ID.

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 22
__construct(Client $clientOrConnection, QueryBuilderChain $queryBuilderChain = new QueryBuilderChain())

No description

Parameters

Client $clientOrConnection
QueryBuilderChain $queryBuilderChain

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

No description

Parameters

Query $query

Return Value

Results

in AbstractClient at line 40
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

in AbstractClient at line 66
object loadObjectFromId(string $className, Id $id)

Load an object by its ID using node(id:) with an inline fragment.

Parameters

string $className

Fully-qualified PHP class name (e.g. \Dagger\Container)
Id $id

The object's ID

Return Value

object

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
Id id()

A unique identifier for this Query.

Return Value

Id

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(AddressId $id)

Load a Address from its ID.

Parameters

AddressId $id

Return Value

Address

at line 378
Binding loadBindingFromID(BindingId $id)

Load a Binding from its ID.

Parameters

BindingId $id

Return Value

Binding

at line 388
CacheVolume loadCacheVolumeFromID(CacheVolumeId $id)

Load a CacheVolume from its ID.

Parameters

CacheVolumeId $id

Return Value

CacheVolume

at line 398
Changeset loadChangesetFromID(ChangesetId $id)

Load a Changeset from its ID.

Parameters

ChangesetId $id

Return Value

Changeset

at line 408
Check loadCheckFromID(CheckId $id)

Load a Check from its ID.

Parameters

CheckId $id

Return Value

Check

at line 418
CheckGroup loadCheckGroupFromID(CheckGroupId $id)

Load a CheckGroup from its ID.

Parameters

CheckGroupId $id

Return Value

CheckGroup

at line 428
ClientFilesyncMirror loadClientFilesyncMirrorFromID(ClientFilesyncMirrorId $id)

Load a ClientFilesyncMirror from its ID.

Parameters

ClientFilesyncMirrorId $id

Return Value

ClientFilesyncMirror

at line 438
Cloud loadCloudFromID(CloudId $id)

Load a Cloud from its ID.

Parameters

CloudId $id

Return Value

Cloud

at line 448
Container loadContainerFromID(ContainerId $id)

Load a Container from its ID.

Parameters

ContainerId $id

Return Value

Container

at line 458
CurrentModule loadCurrentModuleFromID(CurrentModuleId $id)

Load a CurrentModule from its ID.

Parameters

CurrentModuleId $id

Return Value

CurrentModule

at line 468
DiffStat loadDiffStatFromID(DiffStatId $id)

Load a DiffStat from its ID.

Parameters

DiffStatId $id

Return Value

DiffStat

at line 478
Directory loadDirectoryFromID(DirectoryId $id)

Load a Directory from its ID.

Parameters

DirectoryId $id

Return Value

Directory

at line 488
EngineCacheEntry loadEngineCacheEntryFromID(EngineCacheEntryId $id)

Load a EngineCacheEntry from its ID.

Parameters

EngineCacheEntryId $id

Return Value

EngineCacheEntry

at line 498
EngineCacheEntrySet loadEngineCacheEntrySetFromID(EngineCacheEntrySetId $id)

Load a EngineCacheEntrySet from its ID.

Parameters

EngineCacheEntrySetId $id

Return Value

EngineCacheEntrySet

at line 508
EngineCache loadEngineCacheFromID(EngineCacheId $id)

Load a EngineCache from its ID.

Parameters

EngineCacheId $id

Return Value

EngineCache

at line 518
Engine loadEngineFromID(EngineId $id)

Load a Engine from its ID.

Parameters

EngineId $id

Return Value

Engine

at line 528
EnumTypeDef loadEnumTypeDefFromID(EnumTypeDefId $id)

Load a EnumTypeDef from its ID.

Parameters

EnumTypeDefId $id

Return Value

EnumTypeDef

at line 538
EnumValueTypeDef loadEnumValueTypeDefFromID(EnumValueTypeDefId $id)

Load a EnumValueTypeDef from its ID.

Parameters

EnumValueTypeDefId $id

Return Value

EnumValueTypeDef

at line 548
EnvFile loadEnvFileFromID(EnvFileId $id)

Load a EnvFile from its ID.

Parameters

EnvFileId $id

Return Value

EnvFile

at line 558
Env loadEnvFromID(EnvId $id)

Load a Env from its ID.

Parameters

EnvId $id

Return Value

Env

at line 568
EnvVariable loadEnvVariableFromID(EnvVariableId $id)

Load a EnvVariable from its ID.

Parameters

EnvVariableId $id

Return Value

EnvVariable

at line 578
Error loadErrorFromID(ErrorId $id)

Load a Error from its ID.

Parameters

ErrorId $id

Return Value

Error

at line 588
ErrorValue loadErrorValueFromID(ErrorValueId $id)

Load a ErrorValue from its ID.

Parameters

ErrorValueId $id

Return Value

ErrorValue

at line 598
Exportable loadExportableFromID(ExportableId $id)

Load a Exportable from its ID.

Parameters

ExportableId $id

Return Value

Exportable

at line 608
FieldTypeDef loadFieldTypeDefFromID(FieldTypeDefId $id)

Load a FieldTypeDef from its ID.

Parameters

FieldTypeDefId $id

Return Value

FieldTypeDef

at line 618
File loadFileFromID(FileId $id)

Load a File from its ID.

Parameters

FileId $id

Return Value

File

at line 628
FunctionArg loadFunctionArgFromID(FunctionArgId $id)

Load a FunctionArg from its ID.

Parameters

FunctionArgId $id

Return Value

FunctionArg

at line 638
FunctionCallArgValue loadFunctionCallArgValueFromID(FunctionCallArgValueId $id)

Load a FunctionCallArgValue from its ID.

Parameters

FunctionCallArgValueId $id

Return Value

FunctionCallArgValue

at line 648
FunctionCall loadFunctionCallFromID(FunctionCallId $id)

Load a FunctionCall from its ID.

Parameters

FunctionCallId $id

Return Value

FunctionCall

at line 658
Function_ loadFunctionFromID(FunctionId $id)

Load a Function from its ID.

Parameters

FunctionId $id

Return Value

Function_

at line 668
GeneratedCode loadGeneratedCodeFromID(GeneratedCodeId $id)

Load a GeneratedCode from its ID.

Parameters

GeneratedCodeId $id

Return Value

GeneratedCode

at line 678
Generator loadGeneratorFromID(GeneratorId $id)

Load a Generator from its ID.

Parameters

GeneratorId $id

Return Value

Generator

at line 688
GeneratorGroup loadGeneratorGroupFromID(GeneratorGroupId $id)

Load a GeneratorGroup from its ID.

Parameters

GeneratorGroupId $id

Return Value

GeneratorGroup

at line 698
GitRef loadGitRefFromID(GitRefId $id)

Load a GitRef from its ID.

Parameters

GitRefId $id

Return Value

GitRef

at line 708
GitRepository loadGitRepositoryFromID(GitRepositoryId $id)

Load a GitRepository from its ID.

Parameters

GitRepositoryId $id

Return Value

GitRepository

at line 718
HTTPState loadHTTPStateFromID(HTTPStateId $id)

Load a HTTPState from its ID.

Parameters

HTTPStateId $id

Return Value

HTTPState

at line 728
HealthcheckConfig loadHealthcheckConfigFromID(HealthcheckConfigId $id)

Load a HealthcheckConfig from its ID.

Parameters

HealthcheckConfigId $id

Return Value

HealthcheckConfig

at line 738
Host loadHostFromID(HostId $id)

Load a Host from its ID.

Parameters

HostId $id

Return Value

Host

at line 748
InputTypeDef loadInputTypeDefFromID(InputTypeDefId $id)

Load a InputTypeDef from its ID.

Parameters

InputTypeDefId $id

Return Value

InputTypeDef

at line 758
InterfaceTypeDef loadInterfaceTypeDefFromID(InterfaceTypeDefId $id)

Load a InterfaceTypeDef from its ID.

Parameters

InterfaceTypeDefId $id

Return Value

InterfaceTypeDef

at line 768
JsonValue loadJSONValueFromID(JsonValueId $id)

Load a JSONValue from its ID.

Parameters

JsonValueId $id

Return Value

JsonValue

at line 778
LLM loadLLMFromID(LLMId $id)

Load a LLM from its ID.

Parameters

LLMId $id

Return Value

LLM

at line 788
LLMTokenUsage loadLLMTokenUsageFromID(LLMTokenUsageId $id)

Load a LLMTokenUsage from its ID.

Parameters

LLMTokenUsageId $id

Return Value

LLMTokenUsage

at line 798
Label loadLabelFromID(LabelId $id)

Load a Label from its ID.

Parameters

LabelId $id

Return Value

Label

at line 808
ListTypeDef loadListTypeDefFromID(ListTypeDefId $id)

Load a ListTypeDef from its ID.

Parameters

ListTypeDefId $id

Return Value

ListTypeDef

at line 818
ModuleConfigClient loadModuleConfigClientFromID(ModuleConfigClientId $id)

Load a ModuleConfigClient from its ID.

Parameters

ModuleConfigClientId $id

Return Value

ModuleConfigClient

at line 828
Module loadModuleFromID(ModuleId $id)

Load a Module from its ID.

Parameters

ModuleId $id

Return Value

Module

at line 838
ModuleSource loadModuleSourceFromID(ModuleSourceId $id)

Load a ModuleSource from its ID.

Parameters

ModuleSourceId $id

Return Value

ModuleSource

at line 848
ObjectTypeDef loadObjectTypeDefFromID(ObjectTypeDefId $id)

Load a ObjectTypeDef from its ID.

Parameters

ObjectTypeDefId $id

Return Value

ObjectTypeDef

at line 858
PhpSdk loadPhpSdkFromID(PhpSdkId $id)

Load a PhpSdk from its ID.

Parameters

PhpSdkId $id

Return Value

PhpSdk

at line 868
Port loadPortFromID(PortId $id)

Load a Port from its ID.

Parameters

PortId $id

Return Value

Port

at line 878
RemoteGitMirror loadRemoteGitMirrorFromID(RemoteGitMirrorId $id)

Load a RemoteGitMirror from its ID.

Parameters

RemoteGitMirrorId $id

Return Value

RemoteGitMirror

at line 888
SDKConfig loadSDKConfigFromID(SDKConfigId $id)

Load a SDKConfig from its ID.

Parameters

SDKConfigId $id

Return Value

SDKConfig

at line 898
ScalarTypeDef loadScalarTypeDefFromID(ScalarTypeDefId $id)

Load a ScalarTypeDef from its ID.

Parameters

ScalarTypeDefId $id

Return Value

ScalarTypeDef

at line 908
SearchResult loadSearchResultFromID(SearchResultId $id)

Load a SearchResult from its ID.

Parameters

SearchResultId $id

Return Value

SearchResult

at line 918
SearchSubmatch loadSearchSubmatchFromID(SearchSubmatchId $id)

Load a SearchSubmatch from its ID.

Parameters

SearchSubmatchId $id

Return Value

SearchSubmatch

at line 928
Secret loadSecretFromID(SecretId $id)

Load a Secret from its ID.

Parameters

SecretId $id

Return Value

Secret

at line 938
Service loadServiceFromID(ServiceId $id)

Load a Service from its ID.

Parameters

ServiceId $id

Return Value

Service

at line 948
Socket loadSocketFromID(SocketId $id)

Load a Socket from its ID.

Parameters

SocketId $id

Return Value

Socket

at line 958
SourceMap loadSourceMapFromID(SourceMapId $id)

Load a SourceMap from its ID.

Parameters

SourceMapId $id

Return Value

SourceMap

at line 968
Stat loadStatFromID(StatId $id)

Load a Stat from its ID.

Parameters

StatId $id

Return Value

Stat

at line 978
Syncer loadSyncerFromID(SyncerId $id)

Load a Syncer from its ID.

Parameters

SyncerId $id

Return Value

Syncer

at line 988
Terminal loadTerminalFromID(TerminalId $id)

Load a Terminal from its ID.

Parameters

TerminalId $id

Return Value

Terminal

at line 998
TypeDef loadTypeDefFromID(TypeDefId $id)

Load a TypeDef from its ID.

Parameters

TypeDefId $id

Return Value

TypeDef

at line 1008
Up loadUpFromID(UpId $id)

Load a Up from its ID.

Parameters

UpId $id

Return Value

Up

at line 1018
UpGroup loadUpGroupFromID(UpGroupId $id)

Load a UpGroup from its ID.

Parameters

UpGroupId $id

Return Value

UpGroup

at line 1028
Workspace loadWorkspaceFromID(WorkspaceId $id)

Load a Workspace from its ID.

Parameters

WorkspaceId $id

Return Value

Workspace

at line 1038
Module module()

Create a new module.

Return Value

Module

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

No description

Parameters

ModuleSource $modSource
File $introspectionJson

Return Value

Container

at line 1055
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 1082
Node node(Id $id)

Load any object by its ID.

Parameters

Id $id

Return Value

Node

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

Creates a new secret.

Parameters

string $uri
string|null $cacheKey

Return Value

Secret

at line 1107
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 1115
Directory sourceDir()

No description

Return Value

Directory

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

Creates source map metadata.

Parameters

string $filename
int $line
int $column

Return Value

SourceMap

at line 1136
TypeDef typeDef()

Create a new TypeDef.

Return Value

TypeDef

at line 1145
string version()

Get the current Dagger Engine version.

Return Value

string

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

Configure the php-sdk constructor arguments.

Parameters

Directory|null $sdkSourceDir

Return Value

Client