Host

class Host extends AbstractObject implements IdAble

Information about the host environment.

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

Container

containerImage(string $name)

Accesses a container image on the host.

Directory

directory(string $path, array|null $exclude = null, array|null $include = null, bool|null $noCache = false, bool|null $gitignore = false)

Accesses a directory on the host.

File

file(string $path, bool|null $noCache = false)

Accesses a file on the host.

string

findUp(string $name, bool|null $noCache = false)

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

AbstractId

id()

A unique identifier for this Host.

Service

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

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

Service

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

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

Socket

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 Container containerImage(string $name)

Accesses a container image on the host.

Parameters

| string | $name | |

Return Value

| Container | |

at line 29 Directory directory(string $path, array|null $exclude = null, array|null $include = null, bool|null $noCache = false, bool|null $gitignore = false)

Accesses a directory on the host.

Parameters

| string | $path | | | array|null | $exclude | | | array|null | $include | | | bool|null | $noCache | | | bool|null | $gitignore | |

Return Value

| Directory | |

at line 56 File file(string $path, bool|null $noCache = false)

Accesses a file on the host.

Parameters

| string | $path | | | bool|null | $noCache | |

Return Value

| File | |

at line 69 string findUp(string $name, bool|null $noCache = false)

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

Parameters

| string | $name | | | bool|null | $noCache | |

Return Value

| string | |

at line 82 AbstractId id()

A unique identifier for this Host.

Return Value

| AbstractId | |

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

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

Parameters

| array | $ports | | | string|null | $host | |

Return Value

| Service | |

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

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

Parameters

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

Return Value

| Service | |

at line 120 Socket unixSocket(string $path)

Accesses a Unix socket on the host.

Parameters

| string | $path | |

Return Value

| Socket | |

Generated by Doctum, a API Documentation generator and fork of Sami.