MediaWiki REL1_37
|
@newable 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 $IP. | |
Protected Member Functions | |
getRemoteUrl () | |
Get the URL of the remote origin. | |
Static Protected Member Functions | |
static | getCacheFilePath ( $repoDir) |
Compute the path to the cache file for a given directory. | |
static | getViewers () |
Gets the list of repository viewers. | |
Protected Attributes | |
$basedir | |
Location of the .git directory. | |
$cache = [] | |
Cached git information. | |
$cacheFile | |
Path to JSON cache file for pre-computed git information. | |
$repoDir | |
Location of the repository. | |
Static Protected Attributes | |
static | $repo = null |
Singleton for the repo at $IP. | |
Static Private Attributes | |
static array false | $viewers = false |
Map of repo URLs to viewer URLs. | |
@newable
Definition at line 34 of file GitInfo.php.
GitInfo::__construct | ( | $repoDir, | |
$usePrecomputed = true |
|||
) |
string | $repoDir | The root directory of the repo where .git can be found |
bool | $usePrecomputed | Use precomputed information if available |
Definition at line 72 of file GitInfo.php.
References $path, $repoDir, cacheIsComplete(), getCacheFilePath(), and wfDebugLog().
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.
Definition at line 354 of file GitInfo.php.
Referenced by __construct(), and precomputeValues().
|
static |
Definition at line 410 of file GitInfo.php.
References repo().
Referenced by MWDebug\getDebugInfo().
|
staticprotected |
Compute the path to the cache file for a given directory.
string | $repoDir | The root directory of the repo where .git can be found |
Definition at line 117 of file GitInfo.php.
References $IP, $repoDir, and $wgGitInfoCacheDirectory.
Referenced by __construct().
GitInfo::getCurrentBranch | ( | ) |
Get the name of the current branch, or HEAD if not found.
Definition at line 271 of file GitInfo.php.
References getHead().
Referenced by precomputeValues().
GitInfo::getHead | ( | ) |
Get the HEAD of the repo (without any opening "ref: ")
Definition at line 174 of file GitInfo.php.
Referenced by getCurrentBranch(), getHeadCommitDate(), getHeadSHA1(), and precomputeValues().
GitInfo::getHeadCommitDate | ( | ) |
Get the commit date of HEAD entry of the git code repository.
Definition at line 230 of file GitInfo.php.
References $wgGitBin, and getHead().
Referenced by precomputeValues().
GitInfo::getHeadSHA1 | ( | ) |
Get the SHA1 for the current HEAD of the repo.
Definition at line 198 of file GitInfo.php.
References $matches, and getHead().
Referenced by getHeadViewUrl(), and precomputeValues().
GitInfo::getHeadViewUrl | ( | ) |
Get an URL to a web viewer link to the HEAD revision.
Definition at line 289 of file GitInfo.php.
References $matches, $repo, getHeadSHA1(), and getRemoteUrl().
|
protected |
Get the URL of the remote origin.
Definition at line 315 of file GitInfo.php.
Referenced by getHeadViewUrl(), and precomputeValues().
|
staticprotected |
Gets the list of repository viewers.
Definition at line 426 of file GitInfo.php.
References $viewers, and $wgGitRepositoryViewers.
|
static |
Definition at line 402 of file GitInfo.php.
References repo().
Referenced by MWDebug\getDebugInfo().
|
static |
Definition at line 418 of file GitInfo.php.
References repo().
Referenced by MWDebug\getDebugInfo().
|
static |
Check if a string looks like a hex encoded SHA1 hash.
string | $str | The string to check |
Definition at line 165 of file GitInfo.php.
Referenced by MWDebug\getDebugInfo().
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.
Definition at line 371 of file GitInfo.php.
References cacheIsComplete(), getCurrentBranch(), getHead(), getHeadCommitDate(), getHeadSHA1(), getRemoteUrl(), wfDebugLog(), and wfMkdirParents().
|
static |
Get the singleton for the repo at $IP.
Definition at line 151 of file GitInfo.php.
Referenced by currentBranch(), headSHA1(), and headViewUrl().
|
protected |
Location of the .git directory.
Definition at line 44 of file GitInfo.php.
|
protected |
Cached git information.
Definition at line 59 of file GitInfo.php.
|
protected |
Path to JSON cache file for pre-computed git information.
Definition at line 54 of file GitInfo.php.
|
staticprotected |
Singleton for the repo at $IP.
Definition at line 39 of file GitInfo.php.
Referenced by getHeadViewUrl(), and repo().
|
protected |
Location of the repository.
Definition at line 49 of file GitInfo.php.
Referenced by __construct(), and getCacheFilePath().
|
staticprivate |
Map of repo URLs to viewer URLs.
Access via static method getViewers().
Definition at line 64 of file GitInfo.php.
Referenced by getViewers().