Directory
class Directory extends AbstractObject implements IdAble
A directory.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
Converts this directory to a local git repository
Load the directory as a Dagger module source
Return the difference between this directory and another directory, typically an older snapshot.
Change the owner of the directory contents recursively.
Return the difference between this directory and an another directory. The difference is encoded as a directory.
Return the directory's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.
Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features.
Returns a list of files and directories at the given path.
check if a file or directory exists
Writes the contents of the directory to a path on the host.
Return a snapshot with some paths included or excluded
Search up the directory tree for a file or directory, and return its path. If no match, return null
Returns a list of files and directories that matche the given pattern.
A unique identifier for this Directory.
Returns the name of the directory.
Searches for content matching the given regular expression or literal string.
Force evaluation in the engine.
Opens an interactive terminal in new container with this directory mounted inside.
Return a directory with changes from another directory applied to it.
Return a snapshot with a directory added
Retrieves this directory plus the contents of the given file copied to the given path.
Retrieves this directory plus the contents of the given files copied to the given path.
Retrieves this directory plus a new directory created at the given path.
Return a snapshot with a new file added
Retrieves this directory with the given Git-compatible patch applied.
Retrieves this directory with the given Git-compatible patch file applied.
Return a snapshot with a symlink
Retrieves this directory with all file/dir timestamps set to the given time.
Return a snapshot with a subdirectory removed
Return a snapshot with a file removed
Return a snapshot with files removed
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 19
GitRepository
asGit()
Converts this directory to a local git repository
at line 28
Module
asModule(string|null $sourceRootPath = '.')
Load the directory as a Dagger module source
at line 40
ModuleSource
asModuleSource(string|null $sourceRootPath = '.')
Load the directory as a Dagger module source
at line 54
Changeset
changes(Directory $from)
Return the difference between this directory and another directory, typically an older snapshot.
The difference is encoded as a changeset, which also tracks removed files, and can be applied to other directories.
at line 64
Directory
chown(string $path, string $owner)
Change the owner of the directory contents recursively.
at line 75
Directory
diff(Directory $other)
Return the difference between this directory and an another directory. The difference is encoded as a directory.
at line 85
string
digest()
Return the directory's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.
at line 94
Directory
directory(string $path)
Retrieves a directory at the given path.
at line 104
Container
dockerBuild(string|null $dockerfile = 'Dockerfile', Platform|null $platform = null, array|null $buildArgs = null, string|null $target = '', array|null $secrets = null, bool|null $noInit = false)
Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features.
at line 137
array
entries(string|null $path = null)
Returns a list of files and directories at the given path.
at line 149
bool
exists(string $path, ExistsType|null $expectedType = null, bool|null $doNotFollowSymlinks = false)
check if a file or directory exists
at line 165
string
export(string $path, bool|null $wipe = false)
Writes the contents of the directory to a path on the host.
at line 178
File
file(string $path)
Retrieve a file at the given path.
at line 188
Directory
filter(array|null $exclude = null, array|null $include = null)
Return a snapshot with some paths included or excluded
at line 203
string
findUp(string $name, string $start)
Search up the directory tree for a file or directory, and return its path. If no match, return null
at line 214
array
glob(string $pattern)
Returns a list of files and directories that matche the given pattern.
at line 224
AbstractId
id()
A unique identifier for this Directory.
at line 233
string
name()
Returns the name of the directory.
at line 244
array
search(string $pattern, array|null $paths = null, array|null $globs = null, bool|null $literal = false, bool|null $multiline = false, bool|null $dotall = false, bool|null $insensitive = false, bool|null $skipIgnored = false, bool|null $skipHidden = false, bool|null $filesOnly = false, int|null $limit = null)
Searches for content matching the given regular expression or literal string.
Uses Rust regex syntax; escape literal ., [, ], {, }, | with backslashes.
at line 295
DirectoryId
sync()
Force evaluation in the engine.
at line 304
Directory
terminal(Container|null $container = null, array|null $cmd = null, bool|null $experimentalPrivilegedNesting = false, bool|null $insecureRootCapabilities = false)
Opens an interactive terminal in new container with this directory mounted inside.
at line 329
Directory
withChanges(Changeset $changes)
Return a directory with changes from another directory applied to it.
at line 339
Directory
withDirectory(string $path, Directory $source, array|null $exclude = null, array|null $include = null, string|null $owner = '')
Return a snapshot with a directory added
at line 364
Directory
withFile(string $path, File $source, int|null $permissions = null, string|null $owner = '')
Retrieves this directory plus the contents of the given file copied to the given path.
at line 385
Directory
withFiles(string $path, array $sources, int|null $permissions = null)
Retrieves this directory plus the contents of the given files copied to the given path.
at line 399
Directory
withNewDirectory(string $path, int|null $permissions = 420)
Retrieves this directory plus a new directory created at the given path.
at line 412
Directory
withNewFile(string $path, string $contents, int|null $permissions = 420)
Return a snapshot with a new file added
at line 426
Directory
withPatch(string $patch)
Retrieves this directory with the given Git-compatible patch applied.
at line 436
Directory
withPatchFile(File $patch)
Retrieves this directory with the given Git-compatible patch file applied.
at line 446
Directory
withSymlink(string $target, string $linkName)
Return a snapshot with a symlink
at line 457
Directory
withTimestamps(int $timestamp)
Retrieves this directory with all file/dir timestamps set to the given time.
at line 467
Directory
withoutDirectory(string $path)
Return a snapshot with a subdirectory removed
at line 477
Directory
withoutFile(string $path)
Return a snapshot with a file removed
at line 487
Directory
withoutFiles(array $paths)
Return a snapshot with files removed