PHPVersionCheck Class Reference

Collaboration diagram for PHPVersionCheck:

Public Member Functions
	checkExtensionExistence ()
	Displays an error, if a PHP extension does not exist.
	checkRequiredPHPVersion ()
	Displays an error, if the installed php version does not meet the minimum requirement.
	checkVendorExistence ()
	Displays an error, if the vendor/autoload.php file could not be found.
	getIndexErrorOutput ( $title, $longHtml, $shortText)
	Returns an error page, which is suitable for output to the end user via a web browser.
	getPHPInfo ( $impl=false)
	Returns the version of the installed php implementation.
	outputHTMLHeader ()
	Output headers that prevents error pages to be cached.
	setEntryPoint ( $entryPoint)
	triggerError ( $title, $shortText, $longText, $longHtml)
	Display something vaguely comprehensible in the event of a totally unrecoverable error.

Public Attributes
string	$entryPoint = null
	Which entry point we are protecting.
	$functionsExtensionsMapping
	$mwVersion = '1.32'

Detailed Description

Definition at line 29 of file PHPVersionCheck.php.

Member Function Documentation

checkExtensionExistence()

PHPVersionCheck::checkExtensionExistence

(

)

Displays an error, if a PHP extension does not exist.

Definition at line 180 of file PHPVersionCheck.php.

References $ext, are, array(), as, PHP, that, and triggerError().

checkRequiredPHPVersion()

PHPVersionCheck::checkRequiredPHPVersion

(

)

Displays an error, if the installed php version does not meet the minimum requirement.

Definition at line 106 of file PHPVersionCheck.php.

References and(), are, by, copy, from, getPHPInfo(), href, of, or, page, triggerError(), updates(), version, and will.

checkVendorExistence()

PHPVersionCheck::checkVendorExistence

(

)

Displays an error, if the vendor/autoload.php file could not be found.

Definition at line 154 of file PHPVersionCheck.php.

References from, href, on, or, see, that, and triggerError().

getIndexErrorOutput()

PHPVersionCheck::getIndexErrorOutput	(		$title,
			$longHtml,
			$shortText
	)

Returns an error page, which is suitable for output to the end user via a web browser.

Parameters

string	$title
string	$longHtml
string	$shortText

Returns

string

Definition at line 236 of file PHPVersionCheck.php.

References $title, color, div, error, style, text, and title.

Referenced by triggerError().

getPHPInfo()

PHPVersionCheck::getPHPInfo

(

$impl = false

)

Returns the version of the installed php implementation.

Parameters

string

$impl

By default, the function returns the info of the currently installed PHP implementation. Using this parameter the caller can decide, what version info will be returned. Valid values: HHVM, PHP

Returns

array An array of information about the php implementation, containing:

• 'version': The version of the php implementation (specific to the implementation, not the version of the implemented php version)
• 'implementation': The name of the implementation used
• 'vendor': The development group, vendor or developer of the implementation.
• 'upstreamSupported': The minimum version of the implementation supported by the named vendor.
• 'minSupported': The minimum version supported by MediaWiki
• 'upgradeURL': The URL to the website of the implementation that contains upgrade/installation instructions.

Definition at line 79 of file PHPVersionCheck.php.

References array().

Referenced by checkRequiredPHPVersion().

outputHTMLHeader()

PHPVersionCheck::outputHTMLHeader

(

)

Output headers that prevents error pages to be cached.

Definition at line 219 of file PHPVersionCheck.php.

Referenced by triggerError().

setEntryPoint()

PHPVersionCheck::setEntryPoint

(

$entryPoint

)

Parameters

string

$entryPoint

Which entry point we are protecting. One of: index.php load.php api.php mw-config/index.php cli

Definition at line 59 of file PHPVersionCheck.php.

References $entryPoint.

triggerError()

PHPVersionCheck::triggerError	(		$title,
			$shortText,
			$longText,
			$longHtml
	)

Display something vaguely comprehensible in the event of a totally unrecoverable error.

Does not assume access to anything; no globals, no autoloader, no database, no localisation. Safe for PHP4 (and putting this here means that WebStart.php and GlobalSettings.php no longer need to be).

Calling this function kills execution immediately.

Parameters

string

$title

HTML code to be put within an tag @param string $shortText @param string $longText @param string $longHtml

Definition at line 308 of file PHPVersionCheck.php.

References $title, getIndexErrorOutput(), and outputHTMLHeader().

Referenced by checkExtensionExistence(), checkRequiredPHPVersion(), and checkVendorExistence().

Member Data Documentation

$entryPoint

string PHPVersionCheck::$entryPoint = null

Which entry point we are protecting.

One of:

• index.php
• load.php
• api.php
• mw-config/index.php
• cli

Definition at line 49 of file PHPVersionCheck.php.

Referenced by setEntryPoint().

$functionsExtensionsMapping

PHPVersionCheck::$functionsExtensionsMapping

Initial value:

= array(
        'mb_substr'   => 'mbstring',
        'xml_parser_create' => 'xml',
        'ctype_digit' => 'ctype',
        'json_decode' => 'json',
        'iconv'       => 'iconv',
        'mime_content_type' => 'fileinfo',
    )

Definition at line 32 of file PHPVersionCheck.php.

$mwVersion

PHPVersionCheck::$mwVersion = '1.32'

Definition at line 31 of file PHPVersionCheck.php.

---

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

• includes/PHPVersionCheck.php