\DebugBar\DataCollectorMessagesCollector

Provides a way to log messages

It simply delegates all log-level-specific methods to the log method to reduce boilerplate code that a simple Logger that does the same thing with messages regardless of the error level has to implement.

Summary

Methods

Properties

Constants

emergency()
alert()
critical()
error()
warning()
notice()
info()
debug()
__construct()
setDataFormatter()
getDataFormatter()
addMessage()
aggregate()
getMessages()
log()
clear()
collect()
getName()
getWidgets()

No public properties found

No constants found

No protected methods found

$name
$messages
$aggregates
$dataFormater

N/A

No private methods found

No private properties found

N/A

Properties

$name

$name :

Type

$messages

$messages :

Type

$aggregates

$aggregates :

Type

$dataFormater

$dataFormater :

Type

Methods

emergency()

emergency(string  $message, array  $context = array()) : null

System is unusable.

Parameters

string	$message
array	$context

Returns

null

alert()

alert(string  $message, array  $context = array()) : null

Action must be taken immediately.

Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Parameters

string	$message
array	$context

Returns

null

critical()

critical(string  $message, array  $context = array()) : null

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

string	$message
array	$context

Returns

null

error()

error(string  $message, array  $context = array()) : null

Runtime errors that do not require immediate action but should typically be logged and monitored.

Parameters

string	$message
array	$context

Returns

null

warning()

warning(string  $message, array  $context = array()) : null

Exceptional occurrences that are not errors.

Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

Parameters

string	$message
array	$context

Returns

null

notice()

notice(string  $message, array  $context = array()) : null

Normal but significant events.

Parameters

string	$message
array	$context

Returns

null

info()

info(string  $message, array  $context = array()) : null

Interesting events.

Example: User logs in, SQL logs.

Parameters

string	$message
array	$context

Returns

null

debug()

debug(string  $message, array  $context = array()) : null

Detailed debug information.

Parameters

string	$message
array	$context

Returns

null

__construct()

__construct(string  $name = 'messages')

Parameters

string

$name

setDataFormatter()

setDataFormatter(\DebugBar\DataCollector\DataFormatterInterface  $formater)

Sets the data formater instance used by this collector

Parameters

\DebugBar\DataCollector\DataFormatterInterface

$formater

getDataFormatter()

getDataFormatter()

addMessage()

addMessage(mixed  $message, string  $label = 'info',   $isString = true)

Adds a message

A message can be anything from an object to a string

Parameters

mixed	$message
string	$label
	$isString

aggregate()

aggregate(\DebugBar\DataCollector\MessagesAggregateInterface  $messages)

Aggregates messages from other collectors

Parameters

\DebugBar\DataCollector\MessagesAggregateInterface

$messages

getMessages()

getMessages() : array

Returns collected messages

Returns

array

log()

log(  $level,   $message, array  $context = array())

Parameters

	$level
	$message
array	$context

clear()

clear()

Deletes all messages

collect()

collect() : array

Called by the DebugBar when data needs to be collected

Returns

array —

Collected data

getName()

getName() : string

Returns the unique name of the collector

Returns

string

getWidgets()

getWidgets() : array

Returns a hash where keys are control names and their values an array of options as defined in {@see DebugBar\JavascriptRenderer::addControl()}

Returns

array