class File extends AbstractObject implements IdAble

A file.

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

string
contents()

Retrieves the contents of the file.

string
digest(bool|null $excludeMetadata = false)

Return the file'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.

string
export(string $path, bool|null $allowParentDirPath = false)

Writes the file to a file path on the host.

id()

A unique identifier for this File.

string
name()

Retrieves the name of the file.

int
size()

Retrieves the size of the file, in bytes.

sync()

Force evaluation in the engine.

withName(string $name)

Retrieves this file with its name set to the given name.

withTimestamps(int $timestamp)

Retrieves this file with its created/modified timestamps set to the given time.

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 19
string contents()

Retrieves the contents of the file.

Return Value

string

at line 28
string digest(bool|null $excludeMetadata = false)

Return the file'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.

Parameters

bool|null $excludeMetadata

Return Value

string

at line 40
string export(string $path, bool|null $allowParentDirPath = false)

Writes the file to a file path on the host.

Parameters

string $path
bool|null $allowParentDirPath

Return Value

string

at line 53
AbstractId id()

A unique identifier for this File.

Return Value

AbstractId

at line 62
string name()

Retrieves the name of the file.

Return Value

string

at line 71
int size()

Retrieves the size of the file, in bytes.

Return Value

int

at line 80
FileId sync()

Force evaluation in the engine.

Return Value

FileId

at line 89
File withName(string $name)

Retrieves this file with its name set to the given name.

Parameters

string $name

Return Value

File

at line 99
File withTimestamps(int $timestamp)

Retrieves this file with its created/modified timestamps set to the given time.

Parameters

int $timestamp

Return Value

File