GitRef

class GitRef extends AbstractObject implements IdAble

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

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

string

commit()

The resolved commit id at this ref.

GitRef

commonAncestor(GitRef $other)

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

AbstractId

id()

A unique identifier for this GitRef.

string

ref()

The resolved ref name at this ref.

Directory

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 string commit()

The resolved commit id at this ref.

Return Value

| string | |

at line 28 GitRef commonAncestor(GitRef $other)

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

Parameters

| GitRef | $other | |

Return Value

| GitRef | |

at line 38 AbstractId id()

A unique identifier for this GitRef.

Return Value

| AbstractId | |

at line 47 string ref()

The resolved ref name at this ref.

Return Value

| string | |

at line 56 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 | |

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