BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
ParamProcessor\ProcessingError Class Reference

Public Member Functions

 __construct ($message, $severity=self::SEVERITY_NORMAL, $element=false, array $tags=[])
 
 addTags ()
 
 getMessage ()
 
 getElement ()
 
 getSeverity ()
 
 hasSeverity ($severity)
 
 hasTag ($tag)
 
 getTags ()
 
 getAction ()
 
 hasAction ($action)
 
 isFatal ()
 
 shouldLog ()
 
 shouldWarn ()
 
 shouldShow ()
 
 shouldDemand ()
 

Public Attributes

const SEVERITY_MINOR = 0
 
const SEVERITY_LOW = 1
 
const SEVERITY_NORMAL = 2
 
const SEVERITY_HIGH = 3
 
const SEVERITY_FATAL = 4
 
const ACTION_IGNORE = 0
 
const ACTION_LOG = 1
 
const ACTION_WARN = 2
 
const ACTION_SHOW = 3
 
const ACTION_DEMAND = 4
 
 $message
 
 $severity
 
 $element
 

Detailed Description

Since
1.0

GNU GPL v2+

Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Constructor & Destructor Documentation

ParamProcessor\ProcessingError::__construct (   $message,
  $severity = self::SEVERITY_NORMAL,
  $element = false,
array  $tags = [] 
)
Parameters
string$message
integer$severity
string | bool$element
string[]$tags

Member Function Documentation

ParamProcessor\ProcessingError::addTags ( )

Adds one or more tags.

Since
0.4.1
Parameters
string|string[]$criteria
ParamProcessor\ProcessingError::getAction ( )

Returns the action associated with the errors severity.

Since
0.4
Returns
integer Element of the ProcessingError::ACTION_ enum
Exceptions
\Exception
ParamProcessor\ProcessingError::getElement ( )

Returns the element this error occurred at, or 'unknown' when i's unknown.

Since
0.4
Returns
string
ParamProcessor\ProcessingError::getMessage ( )

Returns the error message describing the error.

Since
0.4
Returns
string
ParamProcessor\ProcessingError::getSeverity ( )

Returns the severity of the error.

Since
0.4
Returns
integer Element of the ProcessingError::SEVERITY_ enum
ParamProcessor\ProcessingError::getTags ( )

Returns the tags.

Since
0.4.1
Returns
array
ParamProcessor\ProcessingError::hasAction (   $action)

Returns if the action associated with the severity is equal to or bigger then the provided one.

Since
0.4
Parameters
int$action
Returns
boolean
ParamProcessor\ProcessingError::hasSeverity (   $severity)

Returns if the severity is equal to or bigger then the provided one.

Since
0.4
Parameters
integer$severity
Returns
boolean
ParamProcessor\ProcessingError::hasTag (   $tag)

Returns if the error has a certain tag.

Since
0.4.1
Parameters
string$tag
Returns
boolean
ParamProcessor\ProcessingError::isFatal ( )

Returns if the error is fatal.

Since
0.4
Returns
boolean
ParamProcessor\ProcessingError::shouldDemand ( )

Returns if the error message should be shown, and the output not be rendered.

Since
0.4
Returns
boolean
ParamProcessor\ProcessingError::shouldLog ( )

Returns if the error should be logged.

Since
0.4
Returns
boolean
ParamProcessor\ProcessingError::shouldShow ( )

Returns if the error message should be shown.

Since
0.4
Returns
boolean
ParamProcessor\ProcessingError::shouldWarn ( )

Returns if there should be a warning that errors are present.

Since
0.4
Returns
boolean

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