Documentation

BrowserConsoleHandler extends AbstractProcessingHandler
in package

Application

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

Constants

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

Properties

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

Methods

__construct() : mixed
__destruct() : mixed
__sleep() : mixed
close() : void: Closes the handler.
getBubble() : bool: Gets the bubbling behavior.
getFormatter() : FormatterInterface
getLevel() : Level: 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
pushProcessor() : HandlerInterface
reset() : void
resetStatic() : void: Forget all logged records
send() : void: Convert records to javascript console commands and send it to the browser.
setBubble() : $this: Sets the bubbling behavior.
setFormatter() : HandlerInterface
setLevel() : $this: Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter() : FormatterInterface
getResponseFormat() : string: Checks the format of the response
getResponseFormatFromContentType() : string
processRecord() : LogRecord
registerShutdownFunction() : void: Wrapper for register_shutdown_function to allow overriding
resetProcessors() : void
write() : void: Writes the (already formatted) 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

FORMAT_HTML


    protected
        mixed
    FORMAT_HTML
    = 'html'

FORMAT_JS


    protected
        mixed
    FORMAT_JS
    = 'js'

FORMAT_UNKNOWN


    protected
        mixed
    FORMAT_UNKNOWN
    = 'unknown'

$bubble


        protected
            bool
    $bubble
     = true

$formatter


        protected
            FormatterInterface|null
    $formatter
     = null

$initialized


        protected
        static    bool
    $initialized
     = false

$level


        protected
            Level
    $level
     = \Monolog\Level::Debug

$processors


        protected
            array<string|int, callable>
    $processors
     = []

$records


        protected
        static    array<string|int, LogRecord>
    $records
     = []

__construct()


    public
                    __construct([int|string|Level|LogLevel::* $level = Level::Debug ][, bool $bubble = true ]) : mixed

Parameters

$level : int|string|Level|LogLevel::* = Level::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

__destruct()


    public
                    __destruct() : mixed

__sleep()


    public
                    __sleep() : mixed

close()

Closes the handler.


    public
                    close() : void

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.

getFormatter()


    public
                    getFormatter() : FormatterInterface

Return values

FormatterInterface

getLevel()

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


    public
                    getLevel() : Level

Return values

Level

handle()

Handles a record.


    public
                    handle(LogRecord $record) : bool

Parameters

$record : LogRecord: 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

isHandling()

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


    public
                    isHandling(LogRecord $record) : bool

Parameters

$record : LogRecord: Partial log record having only a level initialized

Return values

bool

popProcessor()


    public
                    popProcessor() : callable

Return values

callable

pushProcessor()


    public
                    pushProcessor(callable $callback) : HandlerInterface

Parameters

$callback : callable

Return values

HandlerInterface

reset()


    public
                    reset() : void

resetStatic()

Forget all logged records


    public
            static        resetStatic() : void

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) : $this

Parameters

$bubble : bool: true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values

$this

setFormatter()


    public
                    setFormatter(FormatterInterface $formatter) : HandlerInterface

Parameters

$formatter : FormatterInterface

Return values

HandlerInterface

setLevel()

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


    public
                    setLevel(Level|LogLevel::* $level) : $this

Parameters

$level : Level|LogLevel::*: Level or level name

Return values

$this

getDefaultFormatter()


    protected
                    getDefaultFormatter() : FormatterInterface

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'

getResponseFormatFromContentType()


    protected
            static        getResponseFormatFromContentType(string $contentType) : string

Parameters

$contentType : string

Return values

string —

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

processRecord()


    protected
                    processRecord(LogRecord $record) : LogRecord

Parameters

$record : LogRecord

Return values

LogRecord

registerShutdownFunction()

Wrapper for register_shutdown_function to allow overriding


    protected
                    registerShutdownFunction() : void

resetProcessors()


    protected
                    resetProcessors() : void

write()

Writes the (already formatted) record down to the log of the implementing handler


    protected
                    write(LogRecord $record) : void

Parameters

$record : LogRecord

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>

generateScript()


    private
            static        generateScript() : string

Return values

string

getConsoleMethodForLevel()


    private
            static        getConsoleMethodForLevel(Level $level) : string

Parameters

$level : Level

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

BrowserConsoleHandler extends AbstractProcessingHandler in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

FORMAT_HTML

FORMAT_JS

FORMAT_UNKNOWN

Properties

$bubble

$formatter

$initialized

$level

$processors

Tags

$records

Methods

__construct()

Parameters

Tags

__destruct()

__sleep()

close()

getBubble()

Return values

getFormatter()

Tags

Return values

getLevel()

Return values

handle()

Parameters

Tags

Return values

handleBatch()

Parameters

Tags

isHandling()

Parameters

Tags

Return values

popProcessor()

Tags

Return values

pushProcessor()

Parameters

Tags

Return values

reset()

resetStatic()

send()

setBubble()

Parameters

Return values

setFormatter()

Parameters

Tags

Return values

setLevel()

Parameters

Tags

Return values

getDefaultFormatter()

Tags

Return values

getResponseFormat()

Tags

Return values

getResponseFormatFromContentType()

Parameters

Tags

Return values

processRecord()

Parameters

Return values

registerShutdownFunction()

resetProcessors()

write()

BrowserConsoleHandler extends AbstractProcessingHandler
in package

Application