GitCommit Class Reference
Public Member Functions | |
| __construct ($repo) | |
| _unserialize ($data) | |
| _serialize () | |
| getHistory () | |
| Get commit history in topological order. | |
| getTree () | |
| Get the tree referenced by this commit. | |
| find ($path) | |
Static Public Member Functions | |
| static | treeDiff ($a, $b) |
Public Attributes | |
| $tree | |
| (string) The tree referenced by this commit, as binary sha1 string. | |
| $parents | |
| (array of string) Parent commits of this commit, as binary sha1 strings. | |
| $author | |
| (GitCommitStamp) The author of this commit. | |
| $committer | |
| (GitCommitStamp) The committer of this commit. | |
| $summary | |
| (string) Commit summary, i.e. the first line of the commit message. | |
| $detail | |
| (string) Everything after the first line of the commit message. | |
Detailed Description
Definition at line 24 of file git_commit.class.php.
Constructor & Destructor Documentation
| GitCommit::__construct | ( | $ | repo | ) |
Definition at line 58 of file git_commit.class.php.
Member Function Documentation
| GitCommit::_serialize | ( | ) |
Definition at line 90 of file git_commit.class.php.
| GitCommit::_unserialize | ( | $ | data | ) |
Definition at line 63 of file git_commit.class.php.
| GitCommit::find | ( | $ | path | ) |
Find the tree or blob at a certain path.
This is a convenience function calling GitTree::find() on the commit's tree.
- Exceptions:
-
GitTreeInvalidPathError The path was found to be invalid. This can happen if you are trying to treat a file like a directory (i.e. foo/bar where foo is a file).
- Parameters:
-
$path (string) The path to look for, relative to this tree.
Definition at line 164 of file git_commit.class.php.
| GitCommit::getHistory | ( | ) |
Get commit history in topological order.
- Returns:
- (array of GitCommit)
Definition at line 107 of file git_commit.class.php.
| GitCommit::getTree | ( | ) |
Get the tree referenced by this commit.
- Returns:
- The GitTree referenced by this commit.
Definition at line 151 of file git_commit.class.php.
| static GitCommit::treeDiff | ( | $ | a, | |
| $ | b | |||
| ) | [static] |
Definition at line 169 of file git_commit.class.php.
Member Data Documentation
| GitCommit::$author |
| GitCommit::$committer |
| GitCommit::$detail |
(string) Everything after the first line of the commit message.
Definition at line 56 of file git_commit.class.php.
| GitCommit::$parents |
(array of string) Parent commits of this commit, as binary sha1 strings.
Definition at line 36 of file git_commit.class.php.
| GitCommit::$summary |
(string) Commit summary, i.e. the first line of the commit message.
Definition at line 51 of file git_commit.class.php.
| GitCommit::$tree |
(string) The tree referenced by this commit, as binary sha1 string.
Definition at line 30 of file git_commit.class.php.
The documentation for this class was generated from the following file:
