BrowserConsoleHandler
extends AbstractProcessingHandler
in package
Handler sending logs to browser's javascript console with no browser extension required
Tags
Table of Contents
- FORMAT_HTML = 'html'
- FORMAT_JS = 'js'
- FORMAT_UNKNOWN = 'unknown'
- $bubble : bool
- $formatter : FormatterInterface|null
- $initialized : bool
- $level : int
- $processors : array<string|int, callable>
- $records : array<string|int, FormattedRecord>
- __construct() : mixed
- __destruct() : mixed
- __sleep() : mixed
- close() : void
- getBubble() : bool
- Gets the bubbling behavior.
- getFormatter() : FormatterInterface
- {@inheritDoc}
- getLevel() : int
- Gets minimum logging level at which this handler will be triggered.
- handle() : bool
- {@inheritDoc}
- handleBatch() : void
- Handles a set of records at once.
- isHandling() : bool
- {@inheritDoc}
- 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
FORMAT_HTML
protected
mixed
FORMAT_HTML
= 'html'
FORMAT_JS
protected
mixed
FORMAT_JS
= 'js'
FORMAT_UNKNOWN
protected
mixed
FORMAT_UNKNOWN
= 'unknown'
Properties
$bubble
protected
bool
$bubble
= true
$formatter
protected
FormatterInterface|null
$formatter
$initialized
protected
static bool
$initialized
= false
$level
protected
int
$level
= MonologLogger::DEBUG
Tags
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$records
protected
static array<string|int, FormattedRecord>
$records
= []
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
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —close()
public
close() : void
Return values
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()
{@inheritDoc}
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Tags
Return values
int —handle()
{@inheritDoc}
public
handle(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
bool —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)
Return values
void —isHandling()
{@inheritDoc}
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
bool —popProcessor()
{@inheritDoc}
public
popProcessor() : callable
Return values
callable —pushProcessor()
{@inheritDoc}
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Return values
HandlerInterface —reset()
public
reset() : void
Return values
void —resetStatic()
Forget all logged records
public
static resetStatic() : void
Return values
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.
Return values
void —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 —setFormatter()
{@inheritDoc}
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|LevelName|\Psr\Log\LogLevel::* $level) : self
Parameters
- $level : Level|LevelName|\Psr\Log\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
Return values
string —One of 'js', 'html' or 'unknown'
getResponseFormatFromContentType()
protected
static getResponseFormatFromContentType(string $contentType) : string
Parameters
- $contentType : string
Tags
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
Return values
array<string|int, mixed> —registerShutdownFunction()
Wrapper for register_shutdown_function to allow overriding
protected
registerShutdownFunction() : void
Return values
void —resetProcessors()
protected
resetProcessors() : void
Return values
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>
Return values
void —writeOutput()
Wrapper for echo to allow overriding
protected
static writeOutput(string $str) : void
Parameters
- $str : string
Return values
void —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(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