Documentation

BrowserConsoleHandler extends AbstractProcessingHandler
in package

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

Tags
author

Olivier Poitrey rs@dailymotion.com

phpstan-import-type

FormattedRecord from AbstractProcessingHandler

Table of Contents

Constants

FORMAT_HTML  = 'html'
FORMAT_JS  = 'js'
FORMAT_UNKNOWN  = 'unknown'

Properties

$bubble  : bool
$formatter  : FormatterInterface|null
$initialized  : bool
$level  : int
$processors  : array<string|int, callable>
$records  : array<string|int, FormattedRecord>

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
{@inheritDoc}
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
handle()  : bool
Handles a record.
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
resetStatic()  : void
Forget all logged records
send()  : void
Convert records to javascript console commands and send it to the browser.
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
{@inheritDoc}
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter()  : FormatterInterface
{@inheritDoc}
getResponseFormat()  : string
Checks the format of the response
getResponseFormatFromContentType()  : string
processRecord()  : array<string|int, mixed>
Processes a record.
registerShutdownFunction()  : void
Wrapper for register_shutdown_function to allow overriding
resetProcessors()  : void
write()  : void
Writes the record down to the log of the implementing handler
writeOutput()  : void
Wrapper for echo to allow overriding
call()  : string
call_array()  : string
dump()  : array<string|int, mixed>
generateScript()  : string
getConsoleMethodForLevel()  : string
handleCustomStyles()  : string
handleStyles()  : array<string|int, string>
quote()  : string

Constants

Properties

$level

protected int $level = \Monolog\Logger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct([int|string $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
$level : int|string = Logger::DEBUG

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

Tags
phpstan-param

Level|LevelName|LogLevel::* $level

__destruct()

public __destruct() : mixed

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Tags
phpstan-return

Level

Return values
int

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

Return values
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.

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

isHandling()

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

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool

send()

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

public static send() : void

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

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(Level|LevelName|LogLevel::* $level) : self
Parameters
$level : Level|LevelName|LogLevel::*

Level or level name

Return values
self

getDefaultFormatter()

{@inheritDoc}

protected getDefaultFormatter() : 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}
Return values
FormatterInterface

getResponseFormat()

Checks the format of the response

protected static getResponseFormat() : string

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

Tags
phpstan-return

self::FORMAT_*

Return values
string —

One of 'js', 'html' or 'unknown'

getResponseFormatFromContentType()

protected static getResponseFormatFromContentType(string $contentType) : string
Parameters
$contentType : string
Tags
phpstan-return

self::FORMAT_*

Return values
string —

One of 'js', 'html' or 'unknown'

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed>

registerShutdownFunction()

Wrapper for register_shutdown_function to allow overriding

protected registerShutdownFunction() : void

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>

writeOutput()

Wrapper for echo to allow overriding

protected static writeOutput(string $str) : void
Parameters
$str : string

call()

private static call(mixed ...$args) : string
Parameters
$args : mixed
Return values
string

call_array()

private static call_array(string $method, array<string|int, mixed> $args) : string
Parameters
$method : string
$args : array<string|int, mixed>
Return values
string

dump()

private static dump(string $title, array<string|int, mixed> $dict) : array<string|int, mixed>
Parameters
$title : string
$dict : array<string|int, mixed>
Return values
array<string|int, mixed>

getConsoleMethodForLevel()

private static getConsoleMethodForLevel(int $level) : string
Parameters
$level : int
Return values
string

handleCustomStyles()

private static handleCustomStyles(string $style, string $string) : string
Parameters
$style : string
$string : string
Return values
string

handleStyles()

private static handleStyles(string $formatted) : array<string|int, string>
Parameters
$formatted : string
Return values
array<string|int, string>

quote()

private static quote(string $arg) : string
Parameters
$arg : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results