FirePHPHandler
extends FirePHPHandler
in package
FirePHPHandler.
Tags
Table of Contents
- HEADER_PREFIX = 'X-Wf'
- Header prefix for Wildfire to recognize & parse headers
- PLUGIN_URI = 'http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.3'
- Must reference a "known" plugin, otherwise headers won't display in FirePHP
- PROTOCOL_URI = 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2'
- WildFire JSON header message format
- STRUCTURE_URI = 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1'
- FirePHP structure for parsing messages & their presentation
- $bubble : bool
- $formatter : FormatterInterface|null
- $initialized : bool
- Whether or not Wildfire vendor-specific headers have been generated & sent yet
- $level : int
- $messageIndex : int
- Shared static message index between potentially multiple handlers
- $processors : array<string|int, callable>
- $sendHeaders : bool
- $headers : mixed
- $response : Response
- __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
- {@inheritDoc}
- handleBatch() : void
- Handles a set of records at once.
- isHandling() : bool
- {@inheritDoc}
- onKernelResponse() : mixed
- Adds the headers to the response once it's created.
- popProcessor() : callable
- {@inheritDoc}
- pushProcessor() : HandlerInterface
- {@inheritDoc}
- reset() : void
- setBubble() : self
- Sets the bubbling behavior.
- setFormatter() : HandlerInterface
- {@inheritDoc}
- setLevel() : self
- Sets minimum logging level at which this handler will be triggered.
- createHeader() : array<string, string>
- Base header creation function used by init headers & record headers
- createRecordHeader() : array<string, string>
- Creates message header from record
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
- getInitHeaders() : array<string, string>
- Wildfire initialization headers to enable message parsing
- headersAccepted() : bool
- Override default behavior since we check the user agent in onKernelResponse.
- isWebRequest() : bool
- Checks if PHP's serving a web request
- processRecord() : array<string|int, mixed>
- Processes a record.
- resetProcessors() : void
- sendHeader() : void
- Send header string to the client
- write() : void
- Writes the record down to the log of the implementing handler
Constants
HEADER_PREFIX
Header prefix for Wildfire to recognize & parse headers
protected
mixed
HEADER_PREFIX
= 'X-Wf'
PLUGIN_URI
Must reference a "known" plugin, otherwise headers won't display in FirePHP
protected
mixed
PLUGIN_URI
= 'http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.3'
PROTOCOL_URI
WildFire JSON header message format
protected
mixed
PROTOCOL_URI
= 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2'
STRUCTURE_URI
FirePHP structure for parsing messages & their presentation
protected
mixed
STRUCTURE_URI
= 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1'
Properties
$bubble
protected
bool
$bubble
= true
$formatter
protected
FormatterInterface|null
$formatter
$initialized
Whether or not Wildfire vendor-specific headers have been generated & sent yet
protected
static bool
$initialized
= false
$level
protected
int
$level
= MonologLogger::DEBUG
Tags
$messageIndex
Shared static message index between potentially multiple handlers
protected
static int
$messageIndex
= 1
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$sendHeaders
protected
static bool
$sendHeaders
= true
$headers
private
mixed
$headers
= []
$response
private
Response
$response
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()
Closes the handler.
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 —onKernelResponse()
Adds the headers to the response once it's created.
public
onKernelResponse(ResponseEvent $event) : mixed
Parameters
- $event : ResponseEvent
Return values
mixed —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 —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 —createHeader()
Base header creation function used by init headers & record headers
protected
createHeader(array<string|int, int|string> $meta, string $message) : array<string, string>
Parameters
- $meta : array<string|int, int|string>
-
Wildfire Plugin, Protocol & Structure Indexes
- $message : string
-
Log message
Tags
Return values
array<string, string> —Complete header string ready for the client as key and message as value
createRecordHeader()
Creates message header from record
protected
createRecordHeader(array<string|int, mixed> $record) : array<string, string>
Parameters
- $record : array<string|int, mixed>
Tags
Return values
array<string, string> —getDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface
Overwrite this if the LineFormatter is not a good default for your handler.
Return values
FormatterInterface —getInitHeaders()
Wildfire initialization headers to enable message parsing
protected
getInitHeaders() : array<string, string>
Tags
Return values
array<string, string> —headersAccepted()
Override default behavior since we check the user agent in onKernelResponse.
protected
headersAccepted() : bool
Return values
bool —isWebRequest()
Checks if PHP's serving a web request
protected
isWebRequest() : bool
Return values
bool —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> —resetProcessors()
protected
resetProcessors() : void
Return values
void —sendHeader()
Send header string to the client
protected
sendHeader(mixed $header, mixed $content) : void
Parameters
- $header : mixed
- $content : mixed
Return values
void —write()
Writes the record down to the log of the implementing handler
protected
abstract write(array<string|int, mixed> $record) : void
Parameters
- $record : array<string|int, mixed>