CRM_Utils_Check_Message

class CRM_Utils_Check_Message

Methods

__construct(string $name, string $message, string $title, string $level = \Psr\Log\LogLevel::WARNING, string $icon = NULL)

Class constructor.

string
getName()

Get name.

string
getMessage()

Get message.

string
getTitle()

No description

int
getLevel()

Get severity level number.

string
getSeverity()

Get severity string.

addHelp(string $help)

Set optional additional help text.

addAction(string $title, string $confirmation, string $type, array $params)

Set optional additional actions text.

setLevel(string|int $level)

Set severity level

array
toArray()

Convert to array.

bool
isVisible()

Get message visibility.

string
getHiddenUntil()

Get date hidden until.

Details

at line 101
__construct(string $name, string $message, string $title, string $level = \Psr\Log\LogLevel::WARNING, string $icon = NULL)

Class constructor.

Parameters

string $name Symbolic name for the check.
string $message Printable message (short or long).
string $title Printable message (short).
string $level The severity of the message. Use PSR-3 log levels.
string $icon

See also

LogLevel

at line 114
string getName()

Get name.

Return Value

string

at line 123
string getMessage()

Get message.

Return Value

string

at line 130
string getTitle()

Return Value

string

at line 140
int getLevel()

Get severity level number.

Return Value

int

See also

LogLevel

at line 150
string getSeverity()

Get severity string.

Return Value

string

See also

LogLevel

at line 159
addHelp(string $help)

Set optional additional help text.

Parameters

string $help

at line 175
addAction(string $title, string $confirmation, string $type, array $params)

Set optional additional actions text.

Parameters

string $title Text displayed on the status message as a link or button.
string $confirmation Optional confirmation message before performing action
string $type Currently supports: api3 or href
array $params Params to be passed to CRM.api3 or CRM.url depending on type

at line 190
setLevel(string|int $level)

Set severity level

Parameters

string|int $level

Exceptions

CRM_Core_Exception

at line 209
array toArray()

Convert to array.

Return Value

array

at line 236
bool isVisible()

Get message visibility.

Return Value

bool

at line 248
string getHiddenUntil()

Get date hidden until.

Return Value

string