Address

class Address extends AbstractObject implements IdAble

A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.

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

container()

Load a container from the address.

Directory

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

Load a directory from the address.

File

file(array|null $exclude = null, array|null $include = null, bool|null $gitignore = false, bool|null $noCache = false)

Load a file from the address.

GitRef

gitRef()

Load a git ref (branch, tag or commit) from the address.

GitRepository

gitRepository()

Load a git repository from the address.

AbstractId

id()

A unique identifier for this Address.

Secret

secret()

Load a secret from the address.

Service

service()

Load a service from the address.

Socket

socket()

Load a local socket from the address.

string

value()

The address value

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 container()

Load a container from the address.

Return Value

| Container | |

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

Load a directory from the address.

Parameters

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

Return Value

| Directory | |

at line 53 File file(array|null $exclude = null, array|null $include = null, bool|null $gitignore = false, bool|null $noCache = false)

Load a file from the address.

Parameters

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

Return Value

| File | |

at line 78 GitRef gitRef()

Load a git ref (branch, tag or commit) from the address.

Return Value

| GitRef | |

at line 87 GitRepository gitRepository()

Load a git repository from the address.

Return Value

| GitRepository | |

at line 96 AbstractId id()

A unique identifier for this Address.

Return Value

| AbstractId | |

at line 105 Secret secret()

Load a secret from the address.

Return Value

| Secret | |

at line 114 Service service()

Load a service from the address.

Return Value

| Service | |

at line 123 Socket socket()

Load a local socket from the address.

Return Value

| Socket | |

at line 132 string value()

The address value

Return Value

| string | |

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