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 the credits for a single extension and returns this.
	getExtensionCredits ()
	Generate wikitext showing extensions name, URL, author and description.
	listAuthors ($authors)
	Return a formatted unsorted list of authors.
	listToText ($list, $sort=true)
	Convert an array of items into a list for display.
	showEasterEgg ()
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	getExtensionTypeName ($type)
	Returns the internationalized name for an extension type.
static	getExtensionTypes ()
	Returns an array with the base extension types.
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 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.
Protected Attributes
	$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, $name=null)
Static Private Member Functions
static	getMediaWikiCredits ()
	Returns wiki text showing the license information.

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 43 of file SpecialVersion.php.

Member Function Documentation

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

Convert an array or object to a string for display.

Parameters:

$list Mixed: will convert an array to string if given and return the paramater unaltered otherwise

Returns:: Mixed

Definition at line 560 of file SpecialVersion.php.

Referenced by listToText().

Here is the caller graph for this function:

SpecialVersion::compare	(	$	a,
		$	b
	)

Callback to sort extensions by type.

Definition at line 360 of file SpecialVersion.php.

References SpecialPage\getLanguage().

Here is the call graph for this function:

SpecialVersion::execute ( $ par )

main()

Reimplemented from SpecialPage.

Definition at line 50 of file SpecialVersion.php.

References $out, $wgSpecialVersionShowHooks, getExtensionCredits(), getMediaWikiCredits(), SpecialPage\getOutput(), SpecialPage\getRequest(), getWgHooks(), IPInfo(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showEasterEgg(), and softwareInformation().

Here is the call graph for this function:

static SpecialVersion::getCopyrightAndAuthorList ( ) [static]

Returns:: String

Definition at line 99 of file SpecialVersion.php.

References $wgLang, and wfMsg().

Referenced by WebInstaller_Welcome\execute(), and getMediaWikiCredits().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::getCreditsForExtension ( array $ extension )

Creates and formats the credits for a single extension and returns this.

Parameters:

$extension Array

Returns:: string

Definition at line 377 of file SpecialVersion.php.

References getSvnInfo(), listAuthors(), and wfMsg().

Referenced by getExtensionCategory().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Creates and returns the HTML for a single extension category.

Since:: 1.17

Parameters:

$type	String
$message	String

Returns:: string

Definition at line 339 of file SpecialVersion.php.

References $out, $wgExtensionCredits, getCreditsForExtension(), and openExtType().

Referenced by getExtensionCredits().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::getExtensionCredits ( )

Generate wikitext showing extensions name, URL, author and description.

Returns:: String: Wikitext

Definition at line 263 of file SpecialVersion.php.

References $extensions, $extensionTypes, $out, $wgExtensionCredits, $wgExtensionFunctions, $wgParser, Xml\closeElement(), Xml\element(), getExtensionCategory(), getExtensionTypes(), listToText(), Xml\openElement(), openExtType(), wfMsg(), and wfRunHooks().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns the internationalized name for an extension type.

Since:: 1.17

Parameters:

$type String

Returns:: string

Definition at line 253 of file SpecialVersion.php.

References getExtensionTypes().

Here is the call graph for this function:

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, including those added by SpecialVersionExtensionTypes. This is not possible since this hook is passing along $this though.

Since:: 1.17

Returns:: array

Definition at line 225 of file SpecialVersion.php.

References $extensionTypes, wfMsg(), and wfRunHooks().

Referenced by getExtensionCredits(), and getExtensionTypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns wiki text showing the license information.

Returns:: string

Definition at line 81 of file SpecialVersion.php.

References Xml\element(), getCopyrightAndAuthorList(), and wfMsg().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 593 of file SpecialVersion.php.

References $dir, $lines, SpecialPage\file(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by getCreditsForExtension(), getSvnRevision(), getVersion(), and getVersionLinked().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Retrieve the revision number of a Subversion working directory.

Parameters:

$dir	String: directory of the svn checkout

Returns:: Integer: revision number as int

Definition at line 667 of file SpecialVersion.php.

References $dir, and getSvnInfo().

Referenced by ApiQuerySiteinfo\appendGeneralInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Parameters:

$flags String

Returns:: mixed

Definition at line 159 of file SpecialVersion.php.

References $IP, $version, $wgVersion, getSvnInfo(), wfMsg(), wfProfileIn(), and wfProfileOut().

Referenced by Parser\getVariableValue(), wikiStatsOutput\heading(), ApiMain\makeHelpMsg(), and ParserTest\setupRecorder().

Here is the call graph for this function:

Here is the caller graph for this function:

static SpecialVersion::getVersionLinked ( ) [static]

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

Returns:: mixed

Definition at line 187 of file SpecialVersion.php.

References $IP, $version, $wgVersion, getSvnInfo(), wfMsg(), wfProfileIn(), and wfProfileOut().

Referenced by softwareInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::getWgHooks ( ) [private]

Generate wikitext showing hooks in $wgHooks.

Returns:: String: wikitext

Definition at line 453 of file SpecialVersion.php.

References $wgHooks, Xml\closeElement(), Xml\element(), listToText(), Xml\openElement(), and wfMsg().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::IPInfo ( ) [private]

Get information about client's IP address.

Returns:: String: HTML fragment

Definition at line 504 of file SpecialVersion.php.

References SpecialPage\getRequest().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::listAuthors ( $ authors )

Return a formatted unsorted list of authors.

Parameters:

$authors mixed: string or array of strings

Returns:: String: HTML fragment

Definition at line 516 of file SpecialVersion.php.

References listToText(), and wfMsg().

Referenced by getCreditsForExtension().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Convert an array of items into a list for display.

Parameters:

$list	Array of elements to display
$sort	Boolean: whether to sort the items in $list

Returns:: String

Definition at line 536 of file SpecialVersion.php.

References arrayToString(), and SpecialPage\getLanguage().

Referenced by getExtensionCredits(), getWgHooks(), and listAuthors().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 480 of file SpecialVersion.php.

References $out, Xml\element(), and Html\element().

Referenced by getExtensionCategory(), and getExtensionCredits().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialVersion::showEasterEgg ( )

Definition at line 679 of file SpecialVersion.php.

Referenced by execute().

Here is the caller graph for this function:

static SpecialVersion::softwareInformation ( ) [static]

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

Returns:: string

Definition at line 122 of file SpecialVersion.php.

References $dbr, $out, $version, Xml\closeElement(), Xml\element(), getVersionLinked(), Xml\openElement(), wfGetDB(), wfMsg(), and wfRunHooks().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

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

Definition at line 35 of file SpecialVersion.php.

Referenced by getExtensionCredits(), and getExtensionTypes().

SpecialVersion::$firstExtOpened = false [protected]

Definition at line 33 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/viewvc/mediawiki' => 'https://svn.wikimedia.org/viewvc/mediawiki',
        )

Definition at line 37 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