class GitRef extends AbstractObject implements IdAble, Node

A git ref (tag, branch, or commit).

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

asWorkspace(string|null $cwd = '/')

Creates a synthetic workspace from this git ref.

string
commit()

The resolved commit id at this ref.

commonAncestor(GitRef $other)

Find the best common ancestor between this ref and another ref.

Id
id()

A unique identifier for this GitRef.

string
ref()

The resolved ref name at this ref.

tree(bool|null $discardGitDir = false, int|null $depth = 1, bool|null $includeTags = false)

The filesystem tree at this ref.

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
Workspace asWorkspace(string|null $cwd = '/')

Creates a synthetic workspace from this git ref.

Parameters

string|null $cwd

Return Value

Workspace

at line 31
string commit()

The resolved commit id at this ref.

Return Value

string

at line 40
GitRef commonAncestor(GitRef $other)

Find the best common ancestor between this ref and another ref.

Parameters

GitRef $other

Return Value

GitRef

at line 50
Id id()

A unique identifier for this GitRef.

Return Value

Id

at line 59
string ref()

The resolved ref name at this ref.

Return Value

string

at line 68
Directory tree(bool|null $discardGitDir = false, int|null $depth = 1, bool|null $includeTags = false)

The filesystem tree at this ref.

Parameters

bool|null $discardGitDir
int|null $depth
bool|null $includeTags

Return Value

Directory