docs/static/reference/php/Dagger/Workspace.html
class Workspace extends AbstractObject implements IdAble
A Dagger workspace detected from the current working directory.
| | $lastQuery | | from AbstractObject |
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
from AbstractObject
null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
from AbstractObject
string
address()
Canonical Dagger address of the workspace directory.
checks(array|null $include = null, bool|null $noGenerate = null)
Return all checks from modules loaded in the workspace.
string
clientId()
The client ID that owns this workspace's host filesystem.
string
Path to config.toml relative to the workspace boundary (empty if not initialized).
directory(string $path, array|null $exclude = null, array|null $include = null, bool|null $gitignore = false)
Returns a Directory from the workspace.
file(string $path)
Returns a File from the workspace.
string
findUp(string $name, string|null $from = '.')
Search for a file or directory by walking up from the start path within the workspace.
generators(array|null $include = null)
Return all generators from modules loaded in the workspace.
bool
Whether a config.toml file exists in the workspace.
id()
A unique identifier for this Workspace.
bool
Whether .dagger/config.toml exists.
string
path()
Workspace directory path relative to the workspace boundary.
services(array|null $include = null)
Return all services from modules loaded in the workspace.
update()
Refresh workspace-managed state and return the resulting changeset.
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain) No description
| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)No description
| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |
| null|array|string|int|float|bool | |
string address()Canonical Dagger address of the workspace directory.
| string | |
CheckGroup checks(array|null $include = null, bool|null $noGenerate = null)Return all checks from modules loaded in the workspace.
| array|null | $include | | | bool|null | $noGenerate | |
| CheckGroup | |
string clientId()The client ID that owns this workspace's host filesystem.
| string | |
string configPath()Path to config.toml relative to the workspace boundary (empty if not initialized).
| string | |
Directory directory(string $path, array|null $exclude = null, array|null $include = null, bool|null $gitignore = false)Returns a Directory from the workspace.
Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.
| string | $path | | | array|null | $exclude | | | array|null | $include | | | bool|null | $gitignore | |
| Directory | |
File file(string $path)Returns a File from the workspace.
Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.
| string | $path | |
| File | |
string findUp(string $name, string|null $from = '.')Search for a file or directory by walking up from the start path within the workspace.
Returns the absolute workspace path if found, or null if not found.
Relative start paths resolve from the workspace directory.
The search stops at the workspace boundary and will not traverse above it.
| string | $name | | | string|null | $from | |
| string | |
GeneratorGroup generators(array|null $include = null)Return all generators from modules loaded in the workspace.
| array|null | $include | |
| GeneratorGroup | |
bool hasConfig()Whether a config.toml file exists in the workspace.
| bool | |
AbstractId id()A unique identifier for this Workspace.
| AbstractId | |
bool initialized()Whether .dagger/config.toml exists.
| bool | |
string path()Workspace directory path relative to the workspace boundary.
| string | |
UpGroup services(array|null $include = null)Return all services from modules loaded in the workspace.
| array|null | $include | |
| UpGroup | |
Changeset update()Refresh workspace-managed state and return the resulting changeset.
Currently this refreshes existing lockfile entries only.
| Changeset | |
Generated by Doctum, a API Documentation generator and fork of Sami.