Fetch status information from a local git repository. More...

Public Member Functions
	__construct ( $repoDir, $usePrecomputed=true)

	cacheIsComplete ()
	Check to see if the current cache is fully populated.

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

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

	getHeadCommitDate ()
	Get the commit date of HEAD entry of the git code repository.

	getHeadSHA1 ()
	Get the SHA1 for the current HEAD of the repo.

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

	precomputeValues ()
	Precompute and cache git information.

Static Public Member Functions
static	currentBranch ()

static	headSHA1 ()

static	headViewUrl ()

static	isSHA1 ( $str)
	Check if a string looks like a hex encoded SHA1 hash.

static	repo ()
	Get the singleton for the repo at MW_INSTALL_PATH.

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

Protected Attributes
string null	$basedir
	Location of the .git directory.

array	$cache = []
	Cached git information.

string null	$cacheFile
	Path to JSON cache file for pre-computed git information.

string	$repoDir
	Location of the repository.

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

Detailed Description

Fetch status information from a local git repository.

This is used by Special:Version. It can also be used by developers in their LocalSettings.php to ease testing of a branch you work on for a longer period of time. For example:

if ( GitInfo::currentBranch() === 'myrewriteproject' ) {
}

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 33 of file GitInfo.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Utils\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 73 of file GitInfo.php.

References $path, MediaWiki\Utils\GitInfo\$repoDir, MediaWiki\Utils\GitInfo\cacheIsComplete(), and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ cacheIsComplete()

MediaWiki\Utils\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 364 of file GitInfo.php.

Referenced by MediaWiki\Utils\GitInfo\__construct(), and MediaWiki\Utils\GitInfo\precomputeValues().

◆ currentBranch()

static MediaWiki\Utils\GitInfo::currentBranch ( )

static

See also: self::getCurrentBranch

Returns: string

Definition at line 420 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\repo().

◆ getCurrentBranch()

MediaWiki\Utils\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 282 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\getHead().

Referenced by MediaWiki\Utils\GitInfo\precomputeValues().

◆ getHead()

MediaWiki\Utils\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 184 of file GitInfo.php.

Referenced by MediaWiki\Utils\GitInfo\getCurrentBranch(), MediaWiki\Utils\GitInfo\getHeadCommitDate(), MediaWiki\Utils\GitInfo\getHeadSHA1(), and MediaWiki\Utils\GitInfo\precomputeValues().

◆ getHeadCommitDate()

MediaWiki\Utils\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 240 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\getHead(), MediaWiki\MainConfigNames\GitBin, and MediaWiki\Message\Message\isDisabled().

Referenced by MediaWiki\Utils\GitInfo\precomputeValues().

◆ getHeadSHA1()

MediaWiki\Utils\GitInfo::getHeadSHA1 ( )

Get the SHA1 for the current HEAD of the repo.

Returns: string|false A SHA1 or false

Definition at line 208 of file GitInfo.php.

References $matches, and MediaWiki\Utils\GitInfo\getHead().

Referenced by MediaWiki\Utils\GitInfo\getHeadViewUrl(), and MediaWiki\Utils\GitInfo\precomputeValues().

◆ getHeadViewUrl()

MediaWiki\Utils\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 300 of file GitInfo.php.

References $matches, MediaWiki\Utils\GitInfo\$repo, $url, MediaWiki\Utils\GitInfo\getHeadSHA1(), and MediaWiki\Utils\GitInfo\getRemoteUrl().

◆ getRemoteUrl()

MediaWiki\Utils\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 326 of file GitInfo.php.

References $url.

Referenced by MediaWiki\Utils\GitInfo\getHeadViewUrl(), and MediaWiki\Utils\GitInfo\precomputeValues().

◆ headSHA1()

static MediaWiki\Utils\GitInfo::headSHA1 ( )

static

See also: self::getHeadSHA1

Returns: string

Definition at line 412 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\repo().

◆ headViewUrl()

static MediaWiki\Utils\GitInfo::headViewUrl ( )

static

See also: self::getHeadViewUrl()

Returns: string|false

Definition at line 428 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\repo().

◆ isSHA1()

static MediaWiki\Utils\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 175 of file GitInfo.php.

◆ precomputeValues()

MediaWiki\Utils\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 381 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\cacheIsComplete(), MediaWiki\Utils\GitInfo\getCurrentBranch(), MediaWiki\Utils\GitInfo\getHead(), MediaWiki\Utils\GitInfo\getHeadCommitDate(), MediaWiki\Utils\GitInfo\getHeadSHA1(), MediaWiki\Utils\GitInfo\getRemoteUrl(), and wfMkdirParents().

◆ repo()

static MediaWiki\Utils\GitInfo::repo ( )

static

Get the singleton for the repo at MW_INSTALL_PATH.

Returns: GitInfo

Definition at line 162 of file GitInfo.php.

References MediaWiki\Utils\GitInfo\$repo.

Referenced by MediaWiki\Utils\GitInfo\currentBranch(), MediaWiki\Utils\GitInfo\headSHA1(), and MediaWiki\Utils\GitInfo\headViewUrl().

Member Data Documentation

◆ $basedir

string null MediaWiki\Utils\GitInfo::$basedir

protected

Location of the .git directory.

Definition at line 39 of file GitInfo.php.

◆ $cache

array MediaWiki\Utils\GitInfo::$cache = []

protected

Cached git information.

Definition at line 48 of file GitInfo.php.

◆ $cacheFile

string null MediaWiki\Utils\GitInfo::$cacheFile

protected

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

Definition at line 45 of file GitInfo.php.

◆ $repo

self null MediaWiki\Utils\GitInfo::$repo = null

staticprotected

Singleton for the repo at $IP.

Definition at line 36 of file GitInfo.php.

Referenced by MediaWiki\Utils\GitInfo\getHeadViewUrl(), and MediaWiki\Utils\GitInfo\repo().

◆ $repoDir

string MediaWiki\Utils\GitInfo::$repoDir

protected

Location of the repository.

Definition at line 42 of file GitInfo.php.

Referenced by MediaWiki\Utils\GitInfo\__construct().

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

includes/Utils/GitInfo.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cacheIsComplete()

◆ currentBranch()

◆ getCurrentBranch()

◆ getHead()

◆ getHeadCommitDate()

◆ getHeadSHA1()

◆ getHeadViewUrl()

◆ getRemoteUrl()

◆ headSHA1()

◆ headViewUrl()

◆ isSHA1()

◆ precomputeValues()

◆ repo()

Member Data Documentation

◆ $basedir

◆ $cache

◆ $cacheFile

◆ $repo

◆ $repoDir