GitInfo Class Reference

Public Member Functions
	__construct ( $repoDir, $usePrecomputed=true)
	cacheIsComplete ()
	Check to see if the current cache is fully populated. More...
	getCurrentBranch ()
	Get the name of the current branch, or HEAD if not found. More...
	getHead ()
	Get the HEAD of the repo (without any opening "ref: ") More...
	getHeadCommitDate ()
	Get the commit date of HEAD entry of the git code repository. More...
	getHeadSHA1 ()
	Get the SHA1 for the current HEAD of the repo. More...
	getHeadViewUrl ()
	Get an URL to a web viewer link to the HEAD revision. More...
	precomputeValues ()
	Precompute and cache git information. More...

Static Public Member Functions
static	currentBranch ()
static	headSHA1 ()
static	headViewUrl ()
static	isSHA1 ( $str)
	Check if a string looks like a hex encoded SHA1 hash. More...
static	repo ()
	Get the singleton for the repo at MW_INSTALL_PATH. More...

Protected Member Functions
	getRemoteUrl ()
	Get the URL of the remote origin. More...

Protected Attributes
	$basedir
	Location of the .git directory. More...
	$cache = []
	Cached git information. More...
	$cacheFile
	Path to JSON cache file for pre-computed git information. More...
	$repoDir
	Location of the repository. More...

Static Protected Attributes
static	$repo = null
	Singleton for the repo at $IP. More...

Detailed Description

Stability: newable

Note

marked as newable in 1.35 for lack of a better alternative, but should become a stateless service eventually.

Definition at line 40 of file GitInfo.php.

Constructor & Destructor Documentation

__construct()

GitInfo::__construct	(		$repoDir,
			$usePrecomputed = true
	)

Stability: stable

to call

Parameters

string	$repoDir	The root directory of the repo where .git can be found
bool	$usePrecomputed	Use precomputed information if available

See also

precomputeValues

Definition at line 96 of file GitInfo.php.

References $path, $repoDir, cacheIsComplete(), and FormatJson\decode().

Member Function Documentation

cacheIsComplete()

GitInfo::cacheIsComplete

(

)

Check to see if the current cache is fully populated.

Note: This method is public only to make unit testing easier. There's really no strong reason that anything other than a test should want to call this method.

Returns

bool True if all expected cache keys exist, false otherwise

Definition at line 389 of file GitInfo.php.

Referenced by __construct(), and precomputeValues().

currentBranch()

static GitInfo::currentBranch ( )

static

See also

self::getCurrentBranch

Returns

string

Definition at line 445 of file GitInfo.php.

References repo().

Referenced by MWDebug\getDebugInfo().

getCurrentBranch()

GitInfo::getCurrentBranch

(

)

Get the name of the current branch, or HEAD if not found.

Returns

string|false The branch name, HEAD, or false

Definition at line 306 of file GitInfo.php.

References getHead().

Referenced by precomputeValues().

getHead()

GitInfo::getHead

(

)

Get the HEAD of the repo (without any opening "ref: ")

Returns

string|false The HEAD (git reference or SHA1) or false

Definition at line 209 of file GitInfo.php.

Referenced by getCurrentBranch(), getHeadCommitDate(), getHeadSHA1(), and precomputeValues().

getHeadCommitDate()

GitInfo::getHeadCommitDate

(

)

Get the commit date of HEAD entry of the git code repository.

Since

1.22

Returns

int|false Commit date (UNIX timestamp) or false

Definition at line 265 of file GitInfo.php.

References getHead().

Referenced by precomputeValues().

getHeadSHA1()

GitInfo::getHeadSHA1

(

)

Get the SHA1 for the current HEAD of the repo.

Returns

string|false A SHA1 or false

Definition at line 233 of file GitInfo.php.

References $matches, and getHead().

Referenced by getHeadViewUrl(), and precomputeValues().

getHeadViewUrl()

GitInfo::getHeadViewUrl

(

)

Get an URL to a web viewer link to the HEAD revision.

Returns

string|false String if a URL is available or false otherwise

Definition at line 324 of file GitInfo.php.

References $matches, $repo, getHeadSHA1(), and getRemoteUrl().

getRemoteUrl()

GitInfo::getRemoteUrl ( )

protected

Get the URL of the remote origin.

Returns

string|false String if a URL is available or false otherwise.

Definition at line 350 of file GitInfo.php.

Referenced by getHeadViewUrl(), and precomputeValues().

headSHA1()

static GitInfo::headSHA1 ( )

static

See also

self::getHeadSHA1

Returns

string

Definition at line 437 of file GitInfo.php.

References repo().

Referenced by MWDebug\getDebugInfo().

headViewUrl()

static GitInfo::headViewUrl ( )

static

See also

self::getHeadViewUrl()

Returns

string|false

Definition at line 453 of file GitInfo.php.

References repo().

Referenced by MWDebug\getDebugInfo().

isSHA1()

static GitInfo::isSHA1 (   $str )

static

Check if a string looks like a hex encoded SHA1 hash.

Parameters

string

$str

The string to check

Returns

bool Whether or not the string looks like a SHA1

Definition at line 200 of file GitInfo.php.

Referenced by MWDebug\getDebugInfo().

precomputeValues()

GitInfo::precomputeValues

(

)

Precompute and cache git information.

Creates a JSON file in the cache directory associated with this GitInfo instance. This cache file will be used by subsequent GitInfo objects referencing the same directory to avoid needing to examine the .git directory again.

Since

1.24

Definition at line 406 of file GitInfo.php.

References cacheIsComplete(), FormatJson\encode(), getCurrentBranch(), getHead(), getHeadCommitDate(), getHeadSHA1(), getRemoteUrl(), and wfMkdirParents().

repo()

static GitInfo::repo ( )

static

Get the singleton for the repo at MW_INSTALL_PATH.

Returns

GitInfo

Definition at line 187 of file GitInfo.php.

References $repo.

Referenced by currentBranch(), headSHA1(), and headViewUrl().

Member Data Documentation

$basedir

GitInfo::$basedir

protected

Location of the .git directory.

Definition at line 50 of file GitInfo.php.

$cache

GitInfo::$cache = []

protected

Cached git information.

Definition at line 65 of file GitInfo.php.

$cacheFile

GitInfo::$cacheFile

protected

Path to JSON cache file for pre-computed git information.

Definition at line 60 of file GitInfo.php.

$repo

GitInfo::$repo = null

staticprotected

Singleton for the repo at $IP.

Definition at line 45 of file GitInfo.php.

Referenced by getHeadViewUrl(), and repo().

$repoDir

GitInfo::$repoDir

protected

Location of the repository.

Definition at line 55 of file GitInfo.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• includes/GitInfo.php