Class: VersionControl_Git_Object

Source Location: /VersionControl_Git-0.4.4/VersionControl/Git/Object.php

Class Overview

VersionControl_Git_Component
   |
   --VersionControl_Git_Object

The base class for the all Git objects (commit, tree, blob and tag(unsupported))

Author(s):

Kousuke Ebihara <ebihara at php.net>

Copyright:

2010 Kousuke Ebihara

Variables

Methods

Child classes:

VersionControl_Git_Object_Blob: The OO interface for blob object

VersionControl_Git_Object_Tree: The OO interface for tree object

VersionControl_Git_Object_Commit: The class represents Git commits

DummyGitObject: The base class for the all Git objects (commit, tree, blob and tag(unsupported))

Inherited Variables

Class: VersionControl_Git_Component

VersionControl_Git_Component::$git

Inherited Methods

Class: VersionControl_Git_Component

VersionControl_Git_Component::__construct(): Constructor

Class Details

[line 36]
The base class for the all Git objects (commit, tree, blob and tag(unsupported))

Author: Kousuke Ebihara <ebihara@php.net>
Copyright: 2010 Kousuke Ebihara
Abstract:
License: Apache License 2.0

[ Top ]

Class Variables

$id =

[line 43]

The identifier of this object

Access: public

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 51]

VersionControl_Git_Object __construct(
VersionControl_Git
$git, [string
$id = null])

Constructor

Access: public

Overridden in child classes as:

VersionControl_Git_Object_Tree::__construct(): Constructor

Overrides VersionControl_Git_Component::__construct() (Constructor)

Parameters:

VersionControl_Git	`$git`	—	An instance of the VersionControl_Git
string	`$id`	—	An identifier of this object

[ Top ]

fetch [line 66]

VersionControl_Git_Object fetch(
)

Fetch the substance of this object

Object has contents in the Git repository. But it might be large, so script should fetch contents by calling this method only when necessary.

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

Overridden in child classes as:

VersionControl_Git_Object_Blob::fetch(): Fetch the substance of this object

VersionControl_Git_Object_Tree::fetch(): Fetch the substance of this object

VersionControl_Git_Object_Commit::fetch(): Fetch the substance of this object

DummyGitObject::fetch()

[ Top ]

__toString [line 73]

string __toString(
)

Get a value of this instance as string

Return: The identifier of this object
Access: public

[ Top ]