FirePHPHandler
extends AbstractProcessingHandler
in package
uses
WebRequestRecognizerTrait
Simple FirePHP Handler (http://www.firephp.org/), which uses the Wildfire protocol.
Tags
Table of Contents
Constants
- HEADER_PREFIX : mixed = 'X-Wf'
- Header prefix for Wildfire to recognize & parse headers
- PLUGIN_URI : mixed = 'http://meta.firephp.org/Wildfire/Plugin/FirePH...
- Must reference a "known" plugin, otherwise headers won't display in FirePHP
- PROTOCOL_URI : mixed = 'http://meta.wildfirehq.org/Protocol/JsonStream...
- WildFire JSON header message format
- STRUCTURE_URI : mixed = 'http://meta.firephp.org/Wildfire/Structure/Fir...
- FirePHP structure for parsing messages & their presentation
Properties
- $bubble : bool
- $formatter : FormatterInterface|null
- $initialized : bool
- Whether or not Wildfire vendor-specific headers have been generated & sent yet
- $level : Level
- $messageIndex : int
- Shared static message index between potentially multiple handlers
- $processors : array<string|int, callable>
- $sendHeaders : bool
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
- setBubble() : $this
- Sets the bubbling behavior.
- setFormatter() : HandlerInterface
- setLevel() : $this
- 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
- getInitHeaders() : array<string, string>
- Wildfire initialization headers to enable message parsing
- headersAccepted() : bool
- Verifies if the headers are accepted by the current user agent
- isWebRequest() : bool
- Checks if PHP's serving a web request
- processRecord() : LogRecord
- resetProcessors() : void
- sendHeader() : void
- Send header string to the client
- write() : void
- Creates & sends header for a record, ensuring init headers have been sent prior
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
= null
$initialized
Whether or not Wildfire vendor-specific headers have been generated & sent yet
protected
static bool
$initialized
= false
$level
protected
Level
$level
= \Monolog\Level::Debug
$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
Methods
__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
Tags
__destruct()
public
__destruct() : mixed
__sleep()
public
__sleep() : mixed
close()
Closes the handler.
public
close() : void
Tags
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
Tags
Return values
FormatterInterfacegetLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : Level
Return values
Levelhandle()
Handles a record.
public
handle(LogRecord $record) : bool
Parameters
- $record : LogRecord
-
The record to handle
Tags
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
Tags
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
Tags
Return values
boolpopProcessor()
public
popProcessor() : callable
Tags
Return values
callablepushProcessor()
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Tags
Return values
HandlerInterfacereset()
public
reset() : void
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
$thissetFormatter()
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Tags
Return values
HandlerInterfacesetLevel()
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
Tags
Return values
$thiscreateHeader()
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(LogRecord $record) : array<string, string>
Parameters
- $record : LogRecord
Tags
Return values
array<string, string>getDefaultFormatter()
protected
getDefaultFormatter() : FormatterInterface
Tags
Return values
FormatterInterfacegetInitHeaders()
Wildfire initialization headers to enable message parsing
protected
getInitHeaders() : array<string, string>
Tags
Return values
array<string, string>headersAccepted()
Verifies if the headers are accepted by the current user agent
protected
headersAccepted() : bool
Return values
boolisWebRequest()
Checks if PHP's serving a web request
protected
isWebRequest() : bool
Return values
boolprocessRecord()
protected
processRecord(LogRecord $record) : LogRecord
Parameters
- $record : LogRecord
Return values
LogRecordresetProcessors()
protected
resetProcessors() : void
sendHeader()
Send header string to the client
protected
sendHeader(string $header, string $content) : void
Parameters
- $header : string
- $content : string
write()
Creates & sends header for a record, ensuring init headers have been sent prior
protected
write(LogRecord $record) : void
Parameters
- $record : LogRecord