Status
A class representing a certain status
Table of Contents
Properties
- $message : string
- $severity : ContextualFeedbackSeverity
- $title : string
- $value : string
Methods
- __construct() : mixed
- Construct a status
- __toString() : string
- Creates a string representation of a status.
- getMessage() : string
- Gets the status' message (if any)
- getSeverity() : ContextualFeedbackSeverity
- getTitle() : string
- Gets the status' title
- getValue() : string
- Gets the status' value
Properties
$message
protected
string
$message
$severity
protected
ContextualFeedbackSeverity
$severity
$title
protected
string
$title
$value
protected
string
$value
Methods
__construct()
Construct a status
public
__construct(string $title, string $value[, string $message = '' ][, ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK ]) : mixed
All values must be given as constructor arguments. All strings should be localized.
Parameters
- $title : string
-
Status title, eg. "Deprecation log"
- $value : string
-
Status value, eg. "Disabled"
- $message : string = ''
-
Optional message further describing the title/value combination Example:, eg "The deprecation log is important and does foo, to disable it do bar"
- $severity : ContextualFeedbackSeverity = ContextualFeedbackSeverity::OK
-
A severity level
__toString()
Creates a string representation of a status.
public
__toString() : string
Return values
string —String representation of this status.
getMessage()
Gets the status' message (if any)
public
getMessage() : string
Return values
stringgetSeverity()
public
getSeverity() : ContextualFeedbackSeverity
Return values
ContextualFeedbackSeveritygetTitle()
Gets the status' title
public
getTitle() : string
Return values
stringgetValue()
Gets the status' value
public
getValue() : string