Documentation

FirePHPHandler extends AbstractProcessingHandler
in package
Uses WebRequestRecognizerTrait

Simple FirePHP Handler (http://www.firephp.org/), which uses the Wildfire protocol.

Tags
author

Eric Clemmons (@ericclemmons) eric@uxdriven.com

phpstan-import-type

FormattedRecord from AbstractProcessingHandler

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
__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}
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
{@inheritDoc}
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()  : array<string|int, mixed>
Processes a record.
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

$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
phpstan-var

Level

$messageIndex

Shared static message index between potentially multiple handlers

protected static int $messageIndex = 1

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

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
phpstan-param

Level|LevelName|LogLevel::* $level

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.

getLevel()

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

public getLevel() : int
Tags
phpstan-return

Level

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 —

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(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
phpstan-return

non-empty-array<string, string>

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
phpstan-return

non-empty-array<string, string>

see
createHeader()
phpstan-param

FormattedRecord $record

Return values
array<string, string> —

getInitHeaders()

Wildfire initialization headers to enable message parsing

protected getInitHeaders() : array<string, string>
Tags
see
createHeader()
see
sendHeader()
Return values
array<string, string> —

headersAccepted()

Verifies if the headers are accepted by the current user agent

protected headersAccepted() : 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
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed> —

sendHeader()

Send header string to the client

protected sendHeader(string $header, string $content) : void
Parameters
$header : string
$content : string
Return values
void —

write()

Creates & sends header for a record, ensuring init headers have been sent prior

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>
Tags
see
sendHeader()
see
sendInitHeaders()
Return values
void —

Search results