‪TYPO3CMS  ‪main
TYPO3\CMS\Reports\Status Class Reference

Public Member Functions

 __construct ($title, $value, $message='', ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)
 
string getTitle ()
 
string getValue ()
 
string getMessage ()
 
 getSeverity ()
 
string __toString ()
 

Protected Attributes

string $title
 
string $value
 
string $message
 
ContextualFeedbackSeverity $severity
 

Detailed Description

A class representing a certain status

Definition at line 23 of file Status.php.

Constructor & Destructor Documentation

◆ __construct()

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

Construct a status

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

Parameters
string$titleStatus title, eg. "Deprecation log"
string$valueStatus 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"
ContextualFeedbackSeverity$severity‪A severity level

Definition at line 51 of file Status.php.

References TYPO3\CMS\Reports\Status\$message, TYPO3\CMS\Reports\Status\$severity, TYPO3\CMS\Reports\Status\$title, and TYPO3\CMS\Reports\Status\$value.

Member Function Documentation

◆ __toString()

string TYPO3\CMS\Reports\Status::__toString ( )

Creates a string representation of a status.

Returns
‪string String representation of this status.

Definition at line 99 of file Status.php.

◆ getMessage()

string TYPO3\CMS\Reports\Status::getMessage ( )

Gets the status' message (if any)

Returns
‪string

Definition at line 84 of file Status.php.

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

◆ getSeverity()

TYPO3\CMS\Reports\Status::getSeverity ( )

Definition at line 89 of file Status.php.

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

◆ getTitle()

string TYPO3\CMS\Reports\Status::getTitle ( )

Gets the status' title

Returns
‪string

Definition at line 64 of file Status.php.

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

◆ getValue()

string TYPO3\CMS\Reports\Status::getValue ( )

Gets the status' value

Returns
‪string

Definition at line 74 of file Status.php.

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

Member Data Documentation

◆ $message

string TYPO3\CMS\Reports\Status::$message
protected

◆ $severity

ContextualFeedbackSeverity TYPO3\CMS\Reports\Status::$severity
protected

◆ $title

string TYPO3\CMS\Reports\Status::$title
protected

◆ $value

string TYPO3\CMS\Reports\Status::$value
protected