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

Table of Contents

Properties

$bubble  : mixed
$formatter  : FormatterInterface
$initialized  : mixed
$level  : mixed
$processors  : mixed
$records  : mixed

Methods

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

Properties

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

close()

Closes the handler.

public close() : mixed

This will be called automatically when the object is destroyed

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
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) : mixed
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

popProcessor()

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

public popProcessor() : callable
Return values
callable

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self

send()

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

public static send() : mixed

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(int|string $level) : self
Parameters
$level : int|string

Level or level name

Return values
self

getDefaultFormatter()

Gets the default formatter.

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

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>
Return values
array<string|int, mixed>

registerShutdownFunction()

Wrapper for register_shutdown_function to allow overriding

protected registerShutdownFunction() : mixed

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) : mixed
Parameters
$str : string

call_array()

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

dump()

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

handleCustomStyles()

private static handleCustomStyles(mixed $style, mixed $string) : mixed
Parameters
$style : mixed
$string : mixed

handleStyles()

private static handleStyles(mixed $formatted) : mixed
Parameters
$formatted : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results