Monolog\Handler\ChromePHPHandler Class Reference

Handler sending logs to the ChromePHP extension (http://www.chromephp.com/) More...

Inheritance diagram for Monolog\Handler\ChromePHPHandler:

Collaboration diagram for Monolog\Handler\ChromePHPHandler:

Public Member Functions
	__construct ($level=Logger::DEBUG, $bubble=true)
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	__get ($property)
	BC getter for the sendHeaders property that has been made static. More...
	__set ($property, $value)
	BC setter for the sendHeaders property that has been made static. More...
Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	handle (array $record)
	{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record. Parameters array $record The record to handle Returns Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling. } More...
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record. Parameters array $record Partial log record containing only a level key Returns Boolean } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()

Data Fields
const	VERSION = '4.0'
	Version of the extension. More...
const	HEADER_NAME = 'X-ChromeLogger-Data'
	Header name. More...
const	USER_AGENT_REGEX = '{\b(?:Chrome/\d+(?:\.\d+)*|Firefox/(?:4[3-9]|[5-9]\d|\d{3,})(?:\.\d)*)\b}'
	Regular expression to detect supported browsers (matches any Chrome, or Firefox 43+) More...

Protected Member Functions
	getDefaultFormatter ()
	write (array $record)
	Creates & sends header for a record. More...
	send ()
	Sends the log header. More...
	sendHeader ($header, $content)
	Send header string to the client. More...
	headersAccepted ()
	Verifies if the headers are accepted by the current user agent. More...
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Static Protected Attributes
static	$initialized = false
static	$overflowed = false
static	$json
static	$sendHeaders = true

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Handler sending logs to the ChromePHP extension (http://www.chromephp.com/)

This also works out of the box with Firefox 43+

Author

Christophe Coevoet stof@.nosp@m.notk.nosp@m..org

Definition at line 24 of file ChromePHPHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\ChromePHPHandler::__construct	(		$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

int	$level	The minimum logging level at which this handler will be triggered
Boolean	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 64 of file ChromePHPHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, and Monolog\Handler\AbstractHandler\$level.

    {
        parent::__construct($level, $bubble);
        if (!function_exists('json_encode')) {
            throw new \RuntimeException('PHP\'s json extension is required to use Monolog\'s ChromePHPHandler');
        }
    }

Member Function Documentation

__get()

Monolog\Handler\ChromePHPHandler::__get

(

$property

)

BC getter for the sendHeaders property that has been made static.

Definition at line 191 of file ChromePHPHandler.php.

    {
        if ('sendHeaders' !== $property) {
            throw new \InvalidArgumentException('Undefined property '.$property);
        }

        return static::$sendHeaders;
    }

__set()

Monolog\Handler\ChromePHPHandler::__set	(		$property,
			$value
	)

BC setter for the sendHeaders property that has been made static.

Definition at line 203 of file ChromePHPHandler.php.

    {
        if ('sendHeaders' !== $property) {
            throw new \InvalidArgumentException('Undefined property '.$property);
        }

        static::$sendHeaders = $value;
    }

getDefaultFormatter()

Monolog\Handler\ChromePHPHandler::getDefaultFormatter ( )

protected

Definition at line 96 of file ChromePHPHandler.php.

    {
        return new ChromePHPFormatter();
    }

handleBatch()

Monolog\Handler\ChromePHPHandler::handleBatch

(

array

$records

)

{Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 75 of file ChromePHPHandler.php.

References $messages, array, Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\AbstractProcessingHandler\processRecord(), and Monolog\Handler\ChromePHPHandler\send().

    {
        $messages = array();

        foreach ($records as $record) {
            if ($record['level'] < $this->level) {
                continue;
            }
            $messages[] = $this->processRecord($record);
        }

        if (!empty($messages)) {
            $messages = $this->getFormatter()->formatBatch($messages);
            self::$json['rows'] = array_merge(self::$json['rows'], $messages);
            $this->send();
        }
    }

Here is the call graph for this function:

headersAccepted()

Monolog\Handler\ChromePHPHandler::headersAccepted ( )

protected

Verifies if the headers are accepted by the current user agent.

Returns

Boolean

Definition at line 179 of file ChromePHPHandler.php.

References $_SERVER.

Referenced by Monolog\Handler\ChromePHPHandler\send().

    {
        if (empty($_SERVER['HTTP_USER_AGENT'])) {
            return false;
        }

        return preg_match(self::USER_AGENT_REGEX, $_SERVER['HTTP_USER_AGENT']);
    }

Here is the caller graph for this function:

send()

Monolog\Handler\ChromePHPHandler::send ( )

protected

Sends the log header.

See also

sendHeader()

Definition at line 120 of file ChromePHPHandler.php.

References $_SERVER, $data, Monolog\Handler\ChromePHPHandler\$json, array, Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Logger\getLevelName(), Monolog\Handler\ChromePHPHandler\headersAccepted(), Monolog\Handler\ChromePHPHandler\sendHeader(), and Monolog\Logger\WARNING.

Referenced by Monolog\Handler\ChromePHPHandler\handleBatch(), and Monolog\Handler\ChromePHPHandler\write().

    {
        if (self::$overflowed || !self::$sendHeaders) {
            return;
        }

        if (!self::$initialized) {
            self::$initialized = true;

            self::$sendHeaders = $this->headersAccepted();
            if (!self::$sendHeaders) {
                return;
            }

            self::$json['request_uri'] = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
        }

        $json = @json_encode(self::$json);
        $data = base64_encode(utf8_encode($json));
        if (strlen($data) > 240 * 1024) {
            self::$overflowed = true;

            $record = array(
                'message' => 'Incomplete logs, chrome header size limit reached',
                'context' => array(),
                'level' => Logger::WARNING,
                'level_name' => Logger::getLevelName(Logger::WARNING),
                'channel' => 'monolog',
                'datetime' => new \DateTime(),
                'extra' => array(),
            );
            self::$json['rows'][count(self::$json['rows']) - 1] = $this->getFormatter()->format($record);
            $json = @json_encode(self::$json);
            $data = base64_encode(utf8_encode($json));
        }

        if (trim($data) !== '') {
            $this->sendHeader(self::HEADER_NAME, $data);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendHeader()

Monolog\Handler\ChromePHPHandler::sendHeader (   $header,   $content  )

protected

Send header string to the client.

Parameters

string	$header
string	$content

Definition at line 167 of file ChromePHPHandler.php.

References $header, and header.

Referenced by Monolog\Handler\ChromePHPHandler\send().

    {
        if (!headers_sent() && self::$sendHeaders) {
            header(sprintf('%s: %s', $header, $content));
        }
    }

Here is the caller graph for this function:

write()

Monolog\Handler\ChromePHPHandler::write ( array  $record )

protected

Creates & sends header for a record.

See also

sendHeader()

send()

Parameters

array

$record

Definition at line 108 of file ChromePHPHandler.php.

References Monolog\Handler\ChromePHPHandler\send().

    {
        self::$json['rows'][] = $record['formatted'];

        $this->send();
    }

Here is the call graph for this function:

Field Documentation

$initialized

Monolog\Handler\ChromePHPHandler::$initialized = false

staticprotected

Definition at line 41 of file ChromePHPHandler.php.

$json

Monolog\Handler\ChromePHPHandler::$json

staticprotected

Initial value:

= array(
        'version' => self::VERSION,
        'columns' => array('label', 'log', 'backtrace', 'type'),
        'rows' => array(),
    )

Definition at line 52 of file ChromePHPHandler.php.

Referenced by Monolog\Handler\ChromePHPHandler\send().

$overflowed

Monolog\Handler\ChromePHPHandler::$overflowed = false

staticprotected

Definition at line 50 of file ChromePHPHandler.php.

$sendHeaders

Monolog\Handler\ChromePHPHandler::$sendHeaders = true

staticprotected

Definition at line 58 of file ChromePHPHandler.php.

HEADER_NAME

const Monolog\Handler\ChromePHPHandler::HEADER_NAME = 'X-ChromeLogger-Data'

Header name.

Definition at line 34 of file ChromePHPHandler.php.

USER_AGENT_REGEX

const Monolog\Handler\ChromePHPHandler::USER_AGENT_REGEX = '{\b(?:Chrome/\d+(?:\.\d+)*|Firefox/(?:4[3-9]|[5-9]\d|\d{3,})(?:\.\d)*)\b}'

Regular expression to detect supported browsers (matches any Chrome, or Firefox 43+)

Definition at line 39 of file ChromePHPHandler.php.

VERSION

const Monolog\Handler\ChromePHPHandler::VERSION = '4.0'

Version of the extension.

Definition at line 29 of file ChromePHPHandler.php.

Referenced by Monolog\Handler\ChromePHPHandlerTest\testConcurrentHandlers(), Monolog\Handler\ChromePHPHandlerTest\testHeaders(), and Monolog\Handler\ChromePHPHandlerTest\testHeadersOverflow().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/ChromePHPHandler.php