GitRepository

class GitRepository extends AbstractObject implements IdAble

A git repository.

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

GitRef

branch(string $name)

Returns details of a branch.

array

branches(array|null $patterns = null)

branches that match any of the given glob patterns.

GitRef

commit(string $id)

Returns details of a commit.

GitRef

head()

Returns details for HEAD.

AbstractId

id()

A unique identifier for this GitRepository.

GitRef

latestVersion()

Returns details for the latest semver tag.

GitRef

ref(string $name)

Returns details of a ref.

GitRef

tag(string $name)

Returns details of a tag.

array

tags(array|null $patterns = null)

tags that match any of the given glob patterns.

Changeset

uncommitted()

Returns the changeset of uncommitted changes in the git repository.

string

url()

The URL of the git repository.

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 GitRef branch(string $name)

Returns details of a branch.

Parameters

| string | $name | |

Return Value

| GitRef | |

at line 29 array branches(array|null $patterns = null)

branches that match any of the given glob patterns.

Parameters

| array|null | $patterns | |

Return Value

| array | |

at line 41 GitRef commit(string $id)

Returns details of a commit.

Parameters

| string | $id | |

Return Value

| GitRef | |

at line 51 GitRef head()

Returns details for HEAD.

Return Value

| GitRef | |

at line 60 AbstractId id()

A unique identifier for this GitRepository.

Return Value

| AbstractId | |

at line 69 GitRef latestVersion()

Returns details for the latest semver tag.

Return Value

| GitRef | |

at line 78 GitRef ref(string $name)

Returns details of a ref.

Parameters

| string | $name | |

Return Value

| GitRef | |

at line 88 GitRef tag(string $name)

Returns details of a tag.

Parameters

| string | $name | |

Return Value

| GitRef | |

at line 98 array tags(array|null $patterns = null)

tags that match any of the given glob patterns.

Parameters

| array|null | $patterns | |

Return Value

| array | |

at line 110 Changeset uncommitted()

Returns the changeset of uncommitted changes in the git repository.

Return Value

| Changeset | |

at line 119 string url()

The URL of the git repository.

Return Value

| string | |

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