Handler sending logs to browser's javascript console with no browser extension required. More...

Inheritance diagram for Monolog\Handler\BrowserConsoleHandler:

Collaboration diagram for Monolog\Handler\BrowserConsoleHandler:

Public Member Functions

close ()

Closes the handler. More...

reset ()

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: bool 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: bool

} 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 ()

reset ()

isHandling (array $record)

Checks whether the given record will be handled by this handler. More...

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

Removes the processor on top of the stack and returns it. More...

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

reset ()

Static Public Member Functions
static	send ()
	Convert records to javascript console commands and send it to the browser. More...

static	resetStatic ()
	Forget all logged records. More...

Protected Member Functions

getDefaultFormatter ()

Gets the default formatter.

Returns: FormatterInterface

More...

write (array $record)

Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

More...

registerShutdownFunction ()

Wrapper for register_shutdown_function to allow overriding. 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...

getDefaultFormatter ()

Gets the default formatter. More...

Static Protected Member Functions
static	writeOutput ($str)
	Wrapper for echo to allow overriding. More...

static	getResponseFormat ()
	Checks the format of the response. More...

Static Protected Attributes
static	$initialized = false

static	$records = array()

Static Private Member Functions
static	generateScript ()

static	handleStyles ($formatted)

static	handleCustomStyles ($style, $string)

static	dump ($title, array $dict)

static	quote ($arg)

static	call ()

static	call_array ($method, array $args)

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

Handler sending logs to browser's javascript console with no browser extension required.

Author: Olivier Poitrey rs@da.nosp@m.ilym.nosp@m.otion.nosp@m..com

Definition at line 21 of file BrowserConsoleHandler.php.

Member Function Documentation

◆ call()

static Monolog\Handler\BrowserConsoleHandler::call ( )

staticprivate

Definition at line 228 of file BrowserConsoleHandler.php.

    {
        $args = func_get_args();
        $method = array_shift($args);
 
        return static::call_array($method, $args);
    }

◆ call_array()

static Monolog\Handler\BrowserConsoleHandler::call_array	(		$method,
		array	$args
	)

staticprivate

Definition at line 236 of file BrowserConsoleHandler.php.

    {
        return 'c.' . $method . '(' . implode(', ', $args) . ');';
    }

◆ close()

Monolog\Handler\BrowserConsoleHandler::close ( )

Closes the handler.

This will be called automatically when the object is destroyed

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 76 of file BrowserConsoleHandler.php.

    {
        self::resetStatic();
    }

References Monolog\Handler\BrowserConsoleHandler\resetStatic().

Here is the call graph for this function:

◆ dump()

static Monolog\Handler\BrowserConsoleHandler::dump	(		$title,
		array	$dict
	)

staticprivate

Definition at line 204 of file BrowserConsoleHandler.php.

    {
        $script = array();
        $dict = array_filter($dict);
        if (empty($dict)) {
            return $script;
        }
        $script[] = static::call('log', static::quote('%c%s'), static::quote('font-weight: bold'), static::quote($title));
        foreach ($dict as $key => $value) {
            $value = json_encode($value);
            if (empty($value)) {
                $value = static::quote('');
            }
            $script[] = static::call('log', static::quote('%s: %o'), static::quote($key), $value);
        }
 
        return $script;
    }

References $key, and $title.

◆ generateScript()

static Monolog\Handler\BrowserConsoleHandler::generateScript ( )

staticprivate

Definition at line 143 of file BrowserConsoleHandler.php.

    {
        $script = array();
        foreach (static::$records as $record) {
            $context = static::dump('Context', $record['context']);
            $extra = static::dump('Extra', $record['extra']);
 
            if (empty($context) && empty($extra)) {
                $script[] = static::call_array('log', static::handleStyles($record['formatted']));
            } else {
                $script = array_merge($script,
                    array(static::call_array('groupCollapsed', static::handleStyles($record['formatted']))),
                    $context,
                    $extra,
                    array(static::call('groupEnd'))
                );
            }
        }
 
        return "(function (c) {if (c && c.groupCollapsed) {\n" . implode("\n", $script) . "\n}})(console);";
    }

References $context, and $records.

◆ getDefaultFormatter()

Monolog\Handler\BrowserConsoleHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns: FormatterInterface

Formatted output may contain some formatting markers to be transferred to console.log using the c format.

Example of formatted string:

You can do [[blue text]]{color: blue} or [[green background]]{background-color: green; color: white}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 35 of file BrowserConsoleHandler.php.

    {
        return new LineFormatter('[[%channel%]]{macro: autolabel} [[%level_name%]]{font-weight: bold} %message%');
    }

◆ getResponseFormat()

static Monolog\Handler\BrowserConsoleHandler::getResponseFormat ( )

staticprotected

Checks the format of the response.

If Content-Type is set to application/javascript or text/javascript -> js If Content-Type is set to text/html, or is unset -> html If Content-Type is anything else -> unknown

Returns: string One of 'js', 'html' or 'unknown'

Definition at line 123 of file BrowserConsoleHandler.php.

    {
        // Check content type
        foreach (headers_list() as $header) {
            if (stripos($header, 'content-type:') === 0) {
                // This handler only works with HTML and javascript outputs
                // text/javascript is obsolete in favour of application/javascript, but still used
                if (stripos($header, 'application/javascript') !== false || stripos($header, 'text/javascript') !== false) {
                    return 'js';
                }
                if (stripos($header, 'text/html') === false) {
                    return 'unknown';
                }
                break;
            }
        }
 
        return 'html';
    }

References $header.

◆ handleCustomStyles()

static Monolog\Handler\BrowserConsoleHandler::handleCustomStyles	(	$style,
		$string
	)

staticprivate

Definition at line 184 of file BrowserConsoleHandler.php.

    {
        static $colors = array('blue', 'green', 'red', 'magenta', 'orange', 'black', 'grey');
        static $labels = array();
 
        return preg_replace_callback('/macro\s*:(.*?)(?:;|$)/', function ($m) use ($string, &$colors, &$labels) {
            if (trim($m[1]) === 'autolabel') {
                // Format the string as a label with consistent auto assigned background color
                if (!isset($labels[$string])) {
                    $labels[$string] = $colors[count($labels) % count($colors)];
                }
                $color = $labels[$string];
 
                return "background-color: $color; color: white; border-radius: 3px; padding: 0 2px 0 2px";
            }
 
            return $m[1];
        }, $style);
    }

References $m, and $style.

◆ handleStyles()

static Monolog\Handler\BrowserConsoleHandler::handleStyles ( $formatted )

staticprivate

Definition at line 165 of file BrowserConsoleHandler.php.

    {
        $args = array(static::quote('font-weight: normal'));
        $format = '%c' . $formatted;
        preg_match_all('/\[\[(.*?)\]\]\{([^}]*)\}/s', $format, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER);
 
        foreach (array_reverse($matches) as $match) {
            $args[] = static::quote(static::handleCustomStyles($match[2][0], $match[1][0]));
            $args[] = '"font-weight: normal"';
 
            $pos = $match[0][1];
            $format = substr($format, 0, $pos) . '%c' . $match[1][0] . '%c' . substr($format, $pos + strlen($match[0][0]));
        }
 
        array_unshift($args, static::quote($format));
 
        return $args;
    }

References $format.

◆ quote()

static Monolog\Handler\BrowserConsoleHandler::quote ( $arg )

staticprivate

Definition at line 223 of file BrowserConsoleHandler.php.

    {
        return '"' . addcslashes($arg, "\"\n\\") . '"';
    }

◆ registerShutdownFunction()

Monolog\Handler\BrowserConsoleHandler::registerShutdownFunction ( )

protected

Wrapper for register_shutdown_function to allow overriding.

Definition at line 97 of file BrowserConsoleHandler.php.

    {
        if (PHP_SAPI !== 'cli') {
            register_shutdown_function(array('Monolog\Handler\BrowserConsoleHandler', 'send'));
        }
    }

Referenced by Monolog\Handler\BrowserConsoleHandler\write().

Here is the caller graph for this function:

◆ reset()

Monolog\Handler\BrowserConsoleHandler::reset ( )

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 81 of file BrowserConsoleHandler.php.

    {
        self::resetStatic();
    }

References Monolog\Handler\BrowserConsoleHandler\resetStatic().

Here is the call graph for this function:

◆ resetStatic()

static Monolog\Handler\BrowserConsoleHandler::resetStatic ( )

static

Forget all logged records.

Definition at line 89 of file BrowserConsoleHandler.php.

    {
        static::$records = array();
    }

References $records.

Referenced by Monolog\Handler\BrowserConsoleHandler\close(), Monolog\Handler\BrowserConsoleHandler\reset(), and Monolog\Handler\BrowserConsoleHandlerTest\setUp().

Here is the caller graph for this function:

◆ send()

static Monolog\Handler\BrowserConsoleHandler::send ( )

static

Convert records to javascript console commands and send it to the browser.

This method is automatically called on PHP shutdown if output is HTML or Javascript.

Definition at line 59 of file BrowserConsoleHandler.php.

    {
        $format = static::getResponseFormat();
        if ($format === 'unknown') {
            return;
        }
 
        if (count(static::$records)) {
            if ($format === 'html') {
                static::writeOutput('<script>' . static::generateScript() . '</script>');
            } elseif ($format === 'js') {
                static::writeOutput(static::generateScript());
            }
            static::resetStatic();
        }
    }

References $format, and $records.

◆ write()

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

protected

Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 43 of file BrowserConsoleHandler.php.

    {
        // Accumulate records
        static::$records[] = $record;
 
        // Register shutdown handler if not already done
        if (!static::$initialized) {
            static::$initialized = true;
            $this->registerShutdownFunction();
        }
    }

References $records, and Monolog\Handler\BrowserConsoleHandler\registerShutdownFunction().

Here is the call graph for this function:

◆ writeOutput()

static Monolog\Handler\BrowserConsoleHandler::writeOutput ( $str )

staticprotected

Wrapper for echo to allow overriding.

Parameters

string $str

Definition at line 109 of file BrowserConsoleHandler.php.

    {
        echo $str;
    }

Field Documentation

◆ $initialized

Monolog\Handler\BrowserConsoleHandler::$initialized = false

staticprotected

Definition at line 23 of file BrowserConsoleHandler.php.

◆ $records

Monolog\Handler\BrowserConsoleHandler::$records = array()

staticprotected

Definition at line 24 of file BrowserConsoleHandler.php.

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

libs/composer/vendor/monolog/monolog/src/Monolog/Handler/BrowserConsoleHandler.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ call()

◆ call_array()

◆ close()

◆ dump()

◆ generateScript()

◆ getDefaultFormatter()

◆ getResponseFormat()

◆ handleCustomStyles()

◆ handleStyles()

◆ quote()

◆ registerShutdownFunction()

◆ reset()

◆ resetStatic()

◆ send()

◆ write()

◆ writeOutput()

Field Documentation

◆ $initialized

◆ $records