PHP Class GitCommit, gitblog

The Array access allows manipulation of the tree inside the commit

Author: The Young Shepherd

Inheritance: extends GitObject, implements ArrayAccess, implements IteratorAggregate, implements Countable

Show file Open project: rsms/gitblog Class Usage Examples

Public Properties

Property	Type	Description
$authorDate
$authorEmail
$authorName
$comitterDate
$comitterEmail		# GBDateTime
$comitterName
$fields
$files
$id
$logFormat
$message		# GBDateTime
$previousFiles		# array example: array(GitPatch::CREATE => array('file1', 'file3'), GitPatch::DELETE => array('file2'))
$tree

Public Methods

Method	Description
authorUser ( $default = null )	Tries to resolve author as a GBUser
committerUser ( )	Tries to resolve committer as a GBUser
find ( $kwargs = null )	Returns array($commits, $existing, $ntoc)
loadPatches ( $paths = null )	Load a set of GitPatch objects for this commit, optionally restricting to patches affecting $paths
rawPatch ( $paths = null )

Method Details

authorUser() public method

Tries to resolve author as a GBUser

public authorUser ( $default = null )

committerUser() public method

Tries to resolve committer as a GBUser

public committerUser ( )

find() static public method

Returns array($commits, $existing, $ntoc)

static public find ( $kwargs = null )

loadPatches() public method

Load a set of GitPatch objects for this commit, optionally restricting to patches affecting $paths

public loadPatches ( $paths = null )

rawPatch() public method

public rawPatch ( $paths = null )

Property Details

$authorDate public property

public $authorDate

$authorEmail public property

public $authorEmail

$authorName public property

public $authorName

$comitterDate public property

public $comitterDate

$comitterEmail public property

# GBDateTime

public $comitterEmail

$comitterName public property

public $comitterName

$fields public static property

public static $fields

$files public property

public $files

$id public property

public $id

$logFormat public static property

public static $logFormat

$message public property

# GBDateTime

public $message

$previousFiles public property

# array example: array(GitPatch::CREATE => array('file1', 'file3'), GitPatch::DELETE => array('file2'))

public $previousFiles

$tree public property

public $tree