class Host extends AbstractObject implements IdAble

Information about the host environment.

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

directory(string $path, array|null $exclude = null, array|null $include = null)

Accesses a directory on the host.

file(string $path)

Accesses a file on the host.

id()

A unique identifier for this Host.

service(string|null $host = 'localhost', array $ports)

Creates a service that forwards traffic to a specified address via the host.

setSecretFile(string $name, string $path)

Sets a secret given a user-defined name and the file path on the host, and returns the secret.

tunnel(Service $service, array|null $ports = null, bool|null $native = false)

Creates a tunnel that forwards traffic from the host to a service.

unixSocket(string $path)

Accesses a Unix socket on the host.

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
Directory directory(string $path, array|null $exclude = null, array|null $include = null)

Accesses a directory on the host.

Parameters

string $path
array|null $exclude
array|null $include

Return Value

Directory

at line 35
File file(string $path)

Accesses a file on the host.

Parameters

string $path

Return Value

File

at line 45
AbstractId id()

A unique identifier for this Host.

Return Value

AbstractId

at line 54
Service service(string|null $host = 'localhost', array $ports)

Creates a service that forwards traffic to a specified address via the host.

Parameters

string|null $host
array $ports

Return Value

Service

at line 69
Secret setSecretFile(string $name, string $path)

Sets a secret given a user-defined name and the file path on the host, and returns the secret.

The file is limited to a size of 512000 bytes.

Parameters

string $name
string $path

Return Value

Secret

at line 80
Service tunnel(Service $service, array|null $ports = null, bool|null $native = false)

Creates a tunnel that forwards traffic from the host to a service.

Parameters

Service $service
array|null $ports
bool|null $native

Return Value

Service

at line 96
Socket unixSocket(string $path)

Accesses a Unix socket on the host.

Parameters

string $path

Return Value

Socket