Give information about the version of MediaWiki, PHP, the DB and extensions. More...

Inheritance diagram for SpecialVersion:

Collaboration diagram for SpecialVersion:

Public Member Functions
	__construct ()
	compare ($a, $b)
	Callback to sort extensions by type.
	execute ($par)
	main()
	getCreditsForExtension (array $extension)
	Creates and formats a version line for a single extension.
	getEntryPointInfo ()
	Get the list of entry points and their URLs.
	getExtensionCredits ()
	Generate wikitext showing the name, URL, author and description of each extension.
	getSkinCredits ()
	Generate wikitext showing the name, URL, author and description of each skin.
	listAuthors ($authors, $extName, $extDir)
	Return a formatted unsorted list of authors.
	listToText ($list, $sort=true)
	Convert an array of items into a list for display.
Static Public Member Functions
static	arrayToString ($list)
	Convert an array or object to a string for display.
static	getCopyrightAndAuthorList ()
	Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text.
static	getExtAuthorsFileName ($extDir)
	Obtains the full path of an extensions authors or credits file if one exists.
static	getExtensionTypeName ($type)
	Returns the internationalized name for an extension type.
static	getExtensionTypes ()
	Returns an array with the base extension types.
static	getExtLicenseFileName ($extDir)
	Obtains the full path of an extensions copying or license file if one exists.
static	getGitCurrentBranch ($dir)
static	getGitHeadSha1 ($dir)
static	getSvnInfo ($dir)
	Get an associative array of information about a given path, from its .svn subdirectory.
static	getSvnRevision ($dir)
	Retrieve the revision number of a Subversion working directory.
static	getVersion ($flags= '')
	Return a string of the MediaWiki version with SVN revision if available.
static	getVersionLinked ()
	Return a wikitext-formatted string of the MediaWiki version with a link to the SVN revision or the git SHA1 of head if available.
static	softwareInformation ()
	Returns wiki text showing the third party software versions (apache, php, mysql).
Protected Member Functions
	getExtensionCategory ($type, $message)
	Creates and returns the HTML for a single extension category.
	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.
	getParserFunctionHooks ()
	Obtains a list of installed parser function hooks and the associated H2 header.
	getParserTags ()
	Obtains a list of installed parser tags and the associated H2 header.
Protected Attributes
	$coreId = ''
	Stores the current rev id/SHA hash of MediaWiki core.
	$firstExtOpened = false
Static Protected Attributes
static	$extensionTypes = false
static	$viewvcUrls
Private Member Functions
	getWgHooks ()
	Generate wikitext showing hooks in $wgHooks.
	IPInfo ()
	Get information about client's IP address.
	openExtType ($text=null, $name=null)
Static Private Member Functions
static	getMediaWikiCredits ()
	Returns wiki text showing the license information.
static	getVersionLinkedGit ()
static	getVersionLinkedSvn ()
static	getwgVersionLinked ()

Detailed Description

Give information about the version of MediaWiki, PHP, the DB and extensions.

Definition at line 31 of file SpecialVersion.php.

Constructor & Destructor Documentation

SpecialVersion::__construct ( )

Definition at line 47 of file SpecialVersion.php.

Member Function Documentation

static SpecialVersion::arrayToString ( $ list ) [static]

Convert an array or object to a string for display.

Parameters:

mixed $list Will convert an array to string if given and return the paramater unaltered otherwise

Returns:: mixed

Definition at line 1031 of file SpecialVersion.php.

References wfMessage().

SpecialVersion::compare	(	$	a,
		$	b
	)

Callback to sort extensions by type.

Parameters:

array	$a
array	$b

Returns:: int

Definition at line 596 of file SpecialVersion.php.

References SpecialPage\getLanguage().

SpecialVersion::execute ( $ par )

main()

Parameters:

string | null $par

Reimplemented from SpecialPage.

Definition at line 55 of file SpecialVersion.php.

References $ext, $extensions, $file, $IP, $out, array(), as, Html\element(), getEntryPointInfo(), getExtAuthorsFileName(), getExtensionCredits(), getExtLicenseFileName(), getMediaWikiCredits(), SpecialPage\getOutput(), getParserFunctionHooks(), getParserTags(), getSkinCredits(), getWgHooks(), global, IPInfo(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and softwareInformation().

static SpecialVersion::getCopyrightAndAuthorList ( ) [static]

Returns:: string

Definition at line 172 of file SpecialVersion.php.

References $wgLang, array(), format, MWTimestamp\getLocalInstance(), global, text, and wfMessage().

Referenced by getMediaWikiCredits().

SpecialVersion::getCreditsForExtension ( array $ extension )

Creates and formats a version line for a single extension.

Information for five columns will be created. Parameters required in the $extension array for part rendering are indicated in ()

The name of (name), and URL link to (url), the extension
Official version number (version) and if available version control system revision (path), link, and date
If available the short name of the license (license-name) and a linke to ((LICENSE)|(COPYING))(\.txt)? if it exists.
Description of extension (descriptionmsg or description)
List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists

Parameters:

array $extension

Returns:: string Raw HTML

Definition at line 623 of file SpecialVersion.php.

References $cache, $html, $IP, $out, array(), Html\closeElement(), Html\element(), getExtLicenseFileName(), getGitHeadSha1(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), getSvnInfo(), global, Linker\link(), list, listAuthors(), Linker\makeExternalLink(), SpecialPage\msg(), Html\openElement(), Html\rawElement(), wfDebug(), wfGetCache(), and wfMemcKey().

Referenced by getExtensionCategory().

SpecialVersion::getEntryPointInfo ( )

Get the list of entry points and their URLs.

Returns:: string Wikitext

Definition at line 1177 of file SpecialVersion.php.

References $out, $value, $wgArticlePath, array(), as, Html\closeElement(), Html\element(), SpecialPage\getLanguage(), global, SpecialPage\msg(), Html\openElement(), Html\rawElement(), text, wfExpandUrl(), and wfScript().

Referenced by execute().

static SpecialVersion::getExtAuthorsFileName ( $ extDir ) [static]

Obtains the full path of an extensions authors or credits file if one exists.

Parameters:

string $extDir Path to the extensions root directory

Since:: 1.23

Returns:: bool|string False if no such file exists, otherwise returns a path to it.

Definition at line 956 of file SpecialVersion.php.

References $file, and as.

Referenced by ApiQuerySiteinfo\appendExtensions(), execute(), and listAuthors().

SpecialVersion::getExtensionCategory	(	$	type,
		$	message
	)		`[protected]`

Creates and returns the HTML for a single extension category.

Since:: 1.17

Parameters:

string	$type
string	$message

Returns:: string

Definition at line 572 of file SpecialVersion.php.

References $out, $type, array(), as, getCreditsForExtension(), global, and openExtType().

Referenced by getExtensionCredits(), and getSkinCredits().

SpecialVersion::getExtensionCredits ( )

Generate wikitext showing the name, URL, author and description of each extension.

Returns:: string Wikitext

Definition at line 431 of file SpecialVersion.php.

References $extensions, $extensionTypes, $out, $type, array(), as, Xml\closeElement(), Xml\element(), getExtensionCategory(), getExtensionTypes(), global, SpecialPage\msg(), Xml\openElement(), and text.

Referenced by execute().

static SpecialVersion::getExtensionTypeName ( $ type ) [static]

Returns the internationalized name for an extension type.

Since:: 1.17

Parameters:

string $type

Returns:: string

Definition at line 420 of file SpecialVersion.php.

References $type, and getExtensionTypes().

static SpecialVersion::getExtensionTypes ( ) [static]

Returns an array with the base extension types.

Type is stored as array key, the message as array value.

TODO: ideally this would return all extension types.

Since:: 1.17

Returns:: array

Definition at line 392 of file SpecialVersion.php.

References $extensionTypes, array(), text, wfMessage(), and wfRunHooks().

Referenced by getExtensionCredits(), and getExtensionTypeName().

static SpecialVersion::getExtLicenseFileName ( $ extDir ) [static]

Obtains the full path of an extensions copying or license file if one exists.

Parameters:

string $extDir Path to the extensions root directory

Since:: 1.23

Returns:: bool|string False if no such file exists, otherwise returns a path to it.

Definition at line 985 of file SpecialVersion.php.

References $file, and as.

Referenced by ApiQuerySiteinfo\appendExtensions(), execute(), and getCreditsForExtension().

static SpecialVersion::getGitCurrentBranch ( $ dir ) [static]

Parameters:

string $dir Directory of the git checkout

Returns:: bool|string Branch currently checked out

Definition at line 1168 of file SpecialVersion.php.

References $dir.

Referenced by ApiQuerySiteinfo\appendGeneralInfo().

static SpecialVersion::getGitHeadSha1 ( $ dir ) [static]

Parameters:

string $dir Directory of the git checkout

Returns:: bool|string Sha1 of commit HEAD points to

Definition at line 1158 of file SpecialVersion.php.

References $dir.

Referenced by ApiQuerySiteinfo\appendGeneralInfo(), getCreditsForExtension(), and getVersion().

SpecialVersion::getGroupName ( ) [protected]

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns:: string

Since:: 1.21

Reimplemented from SpecialPage.

Definition at line 1234 of file SpecialVersion.php.

static SpecialVersion::getMediaWikiCredits ( ) [static, private]

Returns wiki text showing the license information.

Returns:: string

Definition at line 150 of file SpecialVersion.php.

References $ret, array(), Xml\element(), getCopyrightAndAuthorList(), text, and wfMessage().

Referenced by execute().

SpecialVersion::getParserFunctionHooks ( ) [protected]

Obtains a list of installed parser function hooks and the associated H2 header.

Returns:: string HTML output

Definition at line 543 of file SpecialVersion.php.

References $out, $wgParser, array(), global, listToText(), Linker\makeExternalLink(), SpecialPage\msg(), and Html\rawElement().

Referenced by execute().

SpecialVersion::getParserTags ( ) [protected]

Obtains a list of installed parser tags and the associated H2 header.

Returns:: string HTML output

Definition at line 511 of file SpecialVersion.php.

References $out, $value, $wgParser, array(), global, listToText(), Linker\makeExternalLink(), SpecialPage\msg(), and Html\rawElement().

Referenced by execute().

SpecialVersion::getSkinCredits ( )

Generate wikitext showing the name, URL, author and description of each skin.

Returns:: string Wikitext

Definition at line 485 of file SpecialVersion.php.

References $out, array(), Xml\closeElement(), Xml\element(), getExtensionCategory(), global, SpecialPage\msg(), Xml\openElement(), and text.

Referenced by execute().

static SpecialVersion::getSvnInfo ( $ dir ) [static]

Get an associative array of information about a given path, from its .svn subdirectory.

Returns false on error, such as if the directory was not checked out with subversion.

Returned keys are: Required: checkout-rev The revision which was checked out Optional: directory-rev The revision when the directory was last modified url The subversion URL of the directory repo-url The base URL of the repository viewvc-url A ViewVC URL pointing to the checked-out revision

Parameters:

string $dir

Returns:: array|bool

Definition at line 1068 of file SpecialVersion.php.

References $dir, $lines, array(), as, file, wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by ApiQuerySiteinfo\appendExtensions(), getCreditsForExtension(), getSvnRevision(), getVersion(), and getVersionLinkedSvn().

static SpecialVersion::getSvnRevision ( $ dir ) [static]

Retrieve the revision number of a Subversion working directory.

Parameters:

string $dir Directory of the svn checkout

Returns:: int Revision number

Definition at line 1142 of file SpecialVersion.php.

References $dir, and getSvnInfo().

Referenced by ApiQuerySiteinfo\appendGeneralInfo().

static SpecialVersion::getVersion ( $ flags = '' ) [static]

Return a string of the MediaWiki version with SVN revision if available.

Parameters:

string $flags

Returns:: mixed

Definition at line 252 of file SpecialVersion.php.

References $flags, $IP, getGitHeadSha1(), getSvnInfo(), global, wfMessage(), wfProfileIn(), and wfProfileOut().

Referenced by WikiStatsOutput\heading(), and CheckLanguageCLI\outputWiki().

static SpecialVersion::getVersionLinked ( ) [static]

Return a wikitext-formatted string of the MediaWiki version with a link to the SVN revision or the git SHA1 of head if available.

Git is prefered over Svn The fallback is just $wgVersion

Returns:: mixed

Definition at line 291 of file SpecialVersion.php.

References getVersionLinkedGit(), getVersionLinkedSvn(), global, wfProfileIn(), and wfProfileOut().

Referenced by softwareInformation().

static SpecialVersion::getVersionLinkedGit ( ) [static, private]

Since:: 1.22 Returns the HEAD date in addition to the sha1 and link

Returns:: bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars with link and date, or false on failure

Definition at line 358 of file SpecialVersion.php.

References $IP, $wgLang, Html\element(), getwgVersionLinked(), and global.

Referenced by getVersionLinked().

static SpecialVersion::getVersionLinkedSvn ( ) [static, private]

Returns:: string Global wgVersion + a link to subversion revision of svn BASE

Definition at line 315 of file SpecialVersion.php.

References $IP, getSvnInfo(), getwgVersionLinked(), global, and wfMessage().

Referenced by getVersionLinked().

SpecialVersion::getWgHooks ( ) [private]

Generate wikitext showing hooks in $wgHooks.

Returns:: string Wikitext

Definition at line 806 of file SpecialVersion.php.

References $ret, $wgHooks, array(), as, Html\closeElement(), Html\element(), global, listToText(), SpecialPage\msg(), Html\openElement(), and text.

Referenced by execute().

static SpecialVersion::getwgVersionLinked ( ) [static, private]

Returns:: string

Definition at line 341 of file SpecialVersion.php.

References array(), global, and wfRunHooks().

Referenced by getVersionLinkedGit(), and getVersionLinkedSvn().

SpecialVersion::IPInfo ( ) [private]

Get information about client's IP address.

Returns:: string HTML fragment

Definition at line 882 of file SpecialVersion.php.

References SpecialPage\getRequest().

Referenced by execute().

SpecialVersion::listAuthors	(	$	authors,
		$	extName,
		$	extDir
	)

Return a formatted unsorted list of authors.

'And Others' If an item in the $authors array is '...' it is assumed to indicate an 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)? file if it exists in $dir.

Similarly an entry ending with ' ...]' is assumed to be a link to an 'and others' page.

If no '...' string variant is found, but an authors file is found an 'and others' will be added to the end of the credits.

Parameters:

string \| array	$authors
string	$extName	Name of the extension for link creation
string	$extDir	Path to the extension root directory

Returns:: string HTML fragment

Definition at line 908 of file SpecialVersion.php.

References array(), as, getExtAuthorsFileName(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Linker\link(), listToText(), SpecialPage\msg(), and text.

Referenced by getCreditsForExtension().

SpecialVersion::listToText	(	$	list,
		$	sort = `true`
	)

Convert an array of items into a list for display.

Parameters:

array	$list	List of elements to display
bool	$sort	Whether to sort the items in $list

Returns:: string

Definition at line 1011 of file SpecialVersion.php.

References $sort, array(), and SpecialPage\getLanguage().

Referenced by getParserFunctionHooks(), getParserTags(), getWgHooks(), and listAuthors().

SpecialVersion::openExtType	(	$	text = `null`,
		$	name = `null`
	)		`[private]`

Definition at line 836 of file SpecialVersion.php.

References $name, $out, array(), Html\closeElement(), Html\element(), SpecialPage\msg(), Html\openElement(), Html\rawElement(), and text.

Referenced by getExtensionCategory().

static SpecialVersion::softwareInformation ( ) [static]

Returns wiki text showing the third party software versions (apache, php, mysql).

Returns:: string

Definition at line 207 of file SpecialVersion.php.

References $dbr, $name, $out, array(), as, Xml\closeElement(), Xml\element(), getVersionLinked(), Xml\openElement(), text, wfGetDB(), wfIsHHVM(), wfMessage(), and wfRunHooks().

Referenced by execute().

Member Data Documentation

SpecialVersion::$coreId = '' [protected]

Stores the current rev id/SHA hash of MediaWiki core.

Definition at line 37 of file SpecialVersion.php.

SpecialVersion::$extensionTypes = false [static, protected]

Definition at line 39 of file SpecialVersion.php.

Referenced by getExtensionCredits(), and getExtensionTypes().

SpecialVersion::$firstExtOpened = false [protected]

Definition at line 32 of file SpecialVersion.php.

SpecialVersion::$viewvcUrls [static, protected]

Initial value:

 array(
        'svn+ssh://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
        'http://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
        'https://svn.wikimedia.org/svnroot/mediawiki' => 'https://svn.wikimedia.org/viewvc/mediawiki',
    )

Definition at line 41 of file SpecialVersion.php.

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

includes/specials/SpecialVersion.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation