VersionControl_Git
[ class tree: VersionControl_Git ] [ index: VersionControl_Git ] [ all elements ]
Packages:
VersionControl_Git


Classes:
VersionControl_Git
VersionControl_Git_Component
VersionControl_Git_Exception
VersionControl_Git_Object
VersionControl_Git_Object_Blob
VersionControl_Git_Object_Commit
VersionControl_Git_Object_Tree
VersionControl_Git_Util_Command
VersionControl_Git_Util_RevListFetcher
VersionControl_Git
   DummyGitCommand
   DummyGitComponent
   DummyGitObject
Files:
AllTest.php
Blob.php
checkFixtures.php
Command.php
Commit.php
Component.php
Exception.php
Git.php
Object.php
RevListFetcher.php
Tree.php
VersionControl_GitTest.php
VersionControl_Git_ComponentTest.php
VersionControl_Git_ObjectTest.php
VersionControl_Git_Object_BlobTest.php
VersionControl_Git_Object_CommitTest.php
VersionControl_Git_Object_TreeTest.php
VersionControl_Git_Util_CommandTest.php

Class: VersionControl_Git_Object_Commit

Source Location: /VersionControl_Git-0.4.2/VersionControl/Git/Object/Commit.php

Class Overview

VersionControl_Git_Component
   |
   --VersionControl_Git_Object
      |
      --VersionControl_Git_Object_Commit

The class represents Git commits


Author(s):

Copyright:

  • 2010 Kousuke Ebihara

Variables

Methods

Inherited Variables

Class: VersionControl_Git_Object

VersionControl_Git_Object::$id

Class: VersionControl_Git_Component

VersionControl_Git_Component::$git

Inherited Methods

Class: VersionControl_Git_Object

VersionControl_Git_Object::__construct()
Constructor
VersionControl_Git_Object::fetch()
Fetch the substance of this object
VersionControl_Git_Object::__toString()
Get a value of this instance as string

Class: VersionControl_Git_Component

VersionControl_Git_Component::__construct()
Constructor

Class Details

[line 36]
The class represents Git commits


[ Top ]

Class Variables

$author =

[line 57]

The author related to this commit
  • Access: protected

Type:   string


[ Top ]

$committedAt =

[line 85]

The committed time of this commit (timestamp)
  • Access: protected

Type:   int


[ Top ]

$committer =

[line 64]

The commiter related to this commit
  • Access: protected

Type:   string


[ Top ]

$createdAt =

[line 78]

The created time of this commit (timestamp)
  • Access: protected

Type:   int


[ Top ]

$message =

[line 71]

The message related to this commit
  • Access: protected

Type:   string


[ Top ]

$parent =

[line 50]

The parent object related to this commit
  • Access: protected

Type:   array


[ Top ]

$tree =

[line 43]

The tree object related to this commit
  • Access: protected

Type:   string


[ Top ]


Method Detail

createInstanceByArray   [line 95]

VersionControl_Git_Object_Commit createInstanceByArray( VersionControl_Git $git, array $array)

Create an instance of this class that is based on specified array
  • Access: public

Parameters:

VersionControl_Git   $git   —  An instance of the VersionControl_Git
array   $array   —  An array of properties of this commit

[ Top ]

fetch   [line 353]

VersionControl_Git_Object fetch( )

Fetch the substance of this object

If this commit object is not complete, it inserts values to short properties.

  • Return: The "$this" object for method chain
  • Access: public

Overrides VersionControl_Git_Object::fetch() (Fetch the substance of this object)
[ Top ]

getAuthor   [line 235]

string getAuthor( )

Get the author related to this commit
  • Access: public

[ Top ]

getCommittedAt   [line 286]

int getCommittedAt( )

Get the committed time of this commit
  • Access: public

[ Top ]

getCommitter   [line 276]

string getCommitter( )

Get the committer related to this commit
  • Access: public

[ Top ]

getCreatedAt   [line 245]

int getCreatedAt( )

Get the created time of this commit
  • Access: public

[ Top ]

getMessage   [line 308]

string getMessage( )

Get the message related to this commit
  • Access: public

[ Top ]

getParents   [line 186]

array getParents( )

Get the parent objects related to this commit
  • Return: An array of the VersionControl_Git_Object_Commit
  • Access: public

[ Top ]

getTree   [line 143]

string getTree( )

Get the tree object related to this commit
  • Access: public

[ Top ]

hasParents   [line 176]

bool hasParents( )

Check if this commit has parents or not
  • Access: public

[ Top ]

isIncomplete   [line 335]

bool isIncomplete( )

Check if this commit has all mandatory attributes or not
  • Access: public

[ Top ]

parseUser   [line 320]

array parseUser( string $userAndTimestamp)

Parse a string of commiter and authror line
  • Access: protected

Parameters:

string   $userAndTimestamp   —  Author or commiter name with timestamp

[ Top ]

setAuthor   [line 216]

null setAuthor( string $author)

Set the author related to this commit
  • Access: public

Parameters:

string   $author   —  A name of author

[ Top ]

setCommitter   [line 257]

null setCommitter( string $committer)

Set the committer related to this commit
  • Access: public

Parameters:

string   $committer   —  A name of committer

[ Top ]

setMessage   [line 298]

null setMessage( string $message)

Set the message related to this commit
  • Access: public

Parameters:

string   $message   —  A message of this commit

[ Top ]

setParents   [line 155]

null setParents( array $parent)

Set the parent objects related to this commit
  • Access: public

Parameters:

array   $parent   —  An array of parent objects

[ Top ]

setTree   [line 127]

null setTree( string $tree)

Set the tree object related to this commit
  • Access: public

Parameters:

string   $tree   —  A tree object

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:36:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.