TYPO3\CMS\Reports\Status Class Reference

Public Member Functions
	__construct ($title, $value, $message='', $severity=self::OK)
	getTitle ()
	getValue ()
	getMessage ()
	getSeverity ()
	__toString ()

Public Attributes
const	NOTICE = -2
const	INFO = -1
const	OK = 0
const	WARNING = 1
const	ERROR = 2

Protected Attributes
	$title
	$value
	$message
	$severity

Detailed Description

A class representing a certain status

Definition at line 21 of file Status.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Status::__construct	(		$title,
			$value,
			$message = '',
			$severity = self::OK
	)

Construct a status

All values must be given as constructor arguments. All strings should be localized.

Parameters

string	$title	Status title, eg. "Deprecation log"
string	$value	Status value, eg. "Disabled"
string	$message	Optional message further describing the title/value combination Example:, eg "The deprecation log is important and does foo, to disable it do bar"
int	$severity	A severity level. Use one of the constants above!

Definition at line 61 of file Status.php.

References TYPO3\CMS\Reports\Status\$message, TYPO3\CMS\Reports\Status\$severity, TYPO3\CMS\Reports\Status\$title, TYPO3\CMS\Reports\Status\$value, and TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Member Function Documentation

__toString()

TYPO3\CMS\Reports\Status::__toString

(

)

Creates a string representation of a status.

Returns

string String representation of this status.

Definition at line 114 of file Status.php.

References TYPO3\CMS\Reports\Status\$severity.

getMessage()

TYPO3\CMS\Reports\Status::getMessage

(

)

Gets the status' message (if any)

Returns

string

Definition at line 94 of file Status.php.

References TYPO3\CMS\Reports\Status\$message.

getSeverity()

TYPO3\CMS\Reports\Status::getSeverity

(

)

Gets the status' severity

Returns

int

Definition at line 104 of file Status.php.

References TYPO3\CMS\Reports\Status\$severity.

getTitle()

TYPO3\CMS\Reports\Status::getTitle

(

)

Gets the status' title

Returns

string

Definition at line 74 of file Status.php.

References TYPO3\CMS\Reports\Status\$title.

getValue()

TYPO3\CMS\Reports\Status::getValue

(

)

Gets the status' value

Returns

string

Definition at line 84 of file Status.php.

References TYPO3\CMS\Reports\Status\$value.

Member Data Documentation

$message

TYPO3\CMS\Reports\Status::$message

protected

Definition at line 42 of file Status.php.

Referenced by TYPO3\CMS\Reports\Status\__construct(), and TYPO3\CMS\Reports\Status\getMessage().

$severity

TYPO3\CMS\Reports\Status::$severity

protected

Definition at line 47 of file Status.php.

Referenced by TYPO3\CMS\Reports\Status\__construct(), TYPO3\CMS\Reports\Status\__toString(), and TYPO3\CMS\Reports\Status\getSeverity().

$title

TYPO3\CMS\Reports\Status::$title

protected

Definition at line 32 of file Status.php.

Referenced by TYPO3\CMS\Reports\Status\__construct(), and TYPO3\CMS\Reports\Status\getTitle().

$value

TYPO3\CMS\Reports\Status::$value

protected

Definition at line 37 of file Status.php.

Referenced by TYPO3\CMS\Reports\Status\__construct(), and TYPO3\CMS\Reports\Status\getValue().

ERROR

const TYPO3\CMS\Reports\Status::ERROR = 2

Definition at line 27 of file Status.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getFileSystemStatus(), TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolPasswordStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus(), and TYPO3\CMS\Extensionmanager\Report\ExtensionStatus\getStatus().

INFO

const TYPO3\CMS\Reports\Status::INFO = -1

Definition at line 24 of file Status.php.

NOTICE

const TYPO3\CMS\Reports\Status::NOTICE = -2

Definition at line 23 of file Status.php.

Referenced by TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus(), TYPO3\CMS\Extensionmanager\Report\ExtensionStatus\getStatus(), and TYPO3\CMS\Reports\Tests\Unit\Report\Status\Typo3StatusTest\getStatusReturnsXclassStatusObjectWithSeverityNoticeIfXclassExists().

OK

const TYPO3\CMS\Reports\Status::OK = 0

Definition at line 25 of file Status.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getFileSystemStatus(), TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolPasswordStatus(), TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus(), TYPO3\CMS\Extensionmanager\Report\ExtensionStatus\getStatus(), TYPO3\CMS\Reports\Tests\Unit\Report\Status\Typo3StatusTest\getStatusReturnsXclassStatusObjectWithSeverityOkIfNoXclassExists(), and TYPO3\CMS\Reports\Task\SystemStatusUpdateTask\setNotificationEmail().

WARNING

const TYPO3\CMS\Reports\Status::WARNING = 1

Definition at line 26 of file Status.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getFileSystemStatus(), TYPO3\CMS\Install\Report\SecurityStatusReport\getInstallToolProtectionStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus(), and TYPO3\CMS\Extensionmanager\Report\ExtensionStatus\getStatus().