class GitCommit extends AbstractObject implements IdAble, Node

An immutable git 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

GitRef|null
ancestorReleaseTag(bool|null $includePreRelease = false)

The latest semver release tag reachable from this commit.

string
authorEmail()

Git author email.

string
authorName()

Git author name.

string
authoredDate()

Git author date, in RFC3339 format.

string
committedDate()

Git committer date, in RFC3339 format.

string
committerEmail()

Git committer email.

string
committerName()

Git committer name.

Id
id()

A unique identifier for this GitCommit.

string
message()

Full commit message.

string
messageBody()

Commit message body, excluding the headline.

string
messageHeadline()

First line of the commit message.

array
parentShas()

Parent commit SHAs.

GitRef|null
releaseTag(bool|null $includePreRelease = false)

The latest semver release tag that points directly at this commit.

string
sha()

The full commit SHA.

string
shortSha()

The abbreviated commit SHA.

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

The filesystem tree at this commit.

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|null ancestorReleaseTag(bool|null $includePreRelease = false)

The latest semver release tag reachable from this commit.

Parameters

bool|null $includePreRelease

Return Value

GitRef|null

at line 36
string authorEmail()

Git author email.

Return Value

string

at line 45
string authorName()

Git author name.

Return Value

string

at line 54
string authoredDate()

Git author date, in RFC3339 format.

Return Value

string

at line 63
string committedDate()

Git committer date, in RFC3339 format.

Return Value

string

at line 72
string committerEmail()

Git committer email.

Return Value

string

at line 81
string committerName()

Git committer name.

Return Value

string

at line 90
Id id()

A unique identifier for this GitCommit.

Return Value

Id

at line 99
string message()

Full commit message.

Return Value

string

at line 108
string messageBody()

Commit message body, excluding the headline.

Return Value

string

at line 117
string messageHeadline()

First line of the commit message.

Return Value

string

at line 126
array parentShas()

Parent commit SHAs.

Return Value

array

at line 135
GitRef|null releaseTag(bool|null $includePreRelease = false)

The latest semver release tag that points directly at this commit.

Parameters

bool|null $includePreRelease

Return Value

GitRef|null

at line 152
string sha()

The full commit SHA.

Return Value

string

at line 161
string shortSha()

The abbreviated commit SHA.

Return Value

string

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

The filesystem tree at this commit.

Parameters

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

Return Value

Directory