Formats an analysis message.
This tool should be called by any module responding to the analyze hook to properly format the message. It is usually used in the form:
$ret[] = Analyzer::formatMessage(t('This is the message'), 'ok');
The 'ok' status should be used to provide information about things that are acceptable. In general analysis isn't interested in 'ok' messages, but instead the 'warning', which is a category for items that may be broken unless the user knows what he or she is doing, and 'error' for items that are definitely broken are much more useful.
string $message:
string $type: The type of message. This should be "ok", "warning" or "error". Other values can be used but how they are treated by the output routine is undefined.
array A single formatted message, consisting of a key message and a key type.
static function formatMessage($message, $type = 'error') {
return array(
'message' => $message,
'type' => $type,
);
}