Menu

## FirePHPHandler extends AbstractProcessingHandler
in package

FirePHPHandler.php : 21

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

##### Tags

author

  Eric Clemmons (@ericclemmons) eric@uxdriven.com

### 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 : mixed
$formatter : FormatterInterface
$initialized : mixed
  Whether or not Wildfire vendor-specific headers have been generated & sent yet
$level : mixed
$messageIndex : int
  Shared static message index between potentially multiple handlers
$processors : mixed
$sendHeaders : mixed
__construct() : mixed
__destruct() : mixed
__get() : mixed
  BC getter for the sendHeaders property that has been made static
__set() : mixed
  BC setter for the sendHeaders property that has been made static
close() : mixed
  Closes the handler.
getBubble() : bool
  Gets the bubbling behavior.
getFormatter() : FormatterInterface
  Gets the formatter.
getLevel() : int
  Gets minimum logging level at which this handler will be triggered.
handle() : mixed
  {@inheritdoc}
handleBatch() : mixed
  Handles a set of records at once.
isHandling() : bool
  Checks whether the given record will be handled by this handler.
popProcessor() : callable
  Removes the processor on top of the stack and returns it.
pushProcessor() : self
  Adds a processor in the stack.
reset() : mixed
setBubble() : self
  Sets the bubbling behavior.
setFormatter() : self
  Sets the formatter.
setLevel() : self
  Sets minimum logging level at which this handler will be triggered.
createHeader() : array<string|int, mixed>
  Base header creation function used by init headers & record headers
createRecordHeader() : array<string|int, mixed>
  Creates message header from record
getDefaultFormatter() : mixed
  {@inheritDoc}
getInitHeaders() : array<string|int, mixed>
  Wildfire initialization headers to enable message parsing
headersAccepted() : bool
  Verifies if the headers are accepted by the current user agent
processRecord() : array<string|int, mixed>
  Processes a record.
sendHeader() : mixed
  Send header string to the client
write() : void
  Creates & sends header for a record, ensuring init headers have been sent prior

### Constants

#### HEADER_PREFIX

FirePHPHandler.php : 41

Header prefix for Wildfire to recognize & parse headers

`public mixed HEADER_PREFIX = 'X-Wf'`

#### PLUGIN_URI

FirePHPHandler.php : 36

Must reference a "known" plugin, otherwise headers won't display in FirePHP

`public mixed PLUGIN_URI = 'http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.3'`

#### PROTOCOL_URI

FirePHPHandler.php : 26

WildFire JSON header message format

`public mixed PROTOCOL_URI = 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2'`

#### STRUCTURE_URI

FirePHPHandler.php : 31

FirePHP structure for parsing messages & their presentation

`public mixed STRUCTURE_URI = 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1'`

### Properties

#### $bubble

AbstractHandler.php : 27
`protected mixed $bubble = true`

#### $formatter

AbstractHandler.php : 32
`protected FormatterInterface $formatter`

#### $initialized

FirePHPHandler.php : 46

Whether or not Wildfire vendor-specific headers have been generated & sent yet

`protected static mixed $initialized = false`

#### $level

AbstractHandler.php : 26
`protected mixed $level = MonologLogger::DEBUG`

#### $messageIndex

FirePHPHandler.php : 52

Shared static message index between potentially multiple handlers

`protected static int $messageIndex = 1`

#### $processors

AbstractHandler.php : 33
`protected mixed $processors = array()`

#### $sendHeaders

FirePHPHandler.php : 54
`protected static mixed $sendHeaders = true`

### Methods

#### __construct()

AbstractHandler.php : 39
`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

##### Return values

mixed —

#### __destruct()

AbstractHandler.php : 167
`public __destruct() : mixed`

##### Return values

mixed —

#### __get()

FirePHPHandler.php : 175

BC getter for the sendHeaders property that has been made static

`public __get(mixed $property) : mixed`

##### Parameters

$property : mixed

##### Return values

mixed —

#### __set()

FirePHPHandler.php : 187

BC setter for the sendHeaders property that has been made static

`public __set(mixed $property, mixed $value) : mixed`

##### Parameters

$property : mixed
$value : mixed

##### Return values

mixed —

#### close()

AbstractHandler.php : 68

Closes the handler.

`public close() : mixed`

This will be called automatically when the object is destroyed

##### Return values

mixed —

#### getBubble()

AbstractHandler.php : 162

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()

AbstractHandler.php : 110

Gets the formatter.

`public getFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### getLevel()

AbstractHandler.php : 137

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

`public getLevel() : int`

##### Return values

int —

#### handle()

AbstractProcessingHandler.php : 29

{@inheritdoc}

`public handle(array<string|int, mixed> $record) : mixed`

##### Parameters

$record : array<string|int, mixed>

##### Return values

mixed —

#### handleBatch()

AbstractHandler.php : 56

Handles a set of records at once.

`public handleBatch(array<string|int, mixed> $records) : mixed`

##### Parameters

$records : array<string|int, mixed>

  The records to handle (an array of record arrays)

##### Return values

mixed —

#### isHandling()

AbstractHandler.php : 48

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

`public isHandling(array<string|int, mixed> $record) : bool`

##### Parameters

$record : array<string|int, mixed>

  Partial log record containing only a level key

##### Return values

bool —

#### popProcessor()

AbstractHandler.php : 88

Removes the processor on top of the stack and returns it.

`public popProcessor() : callable`

##### Return values

callable —

#### pushProcessor()

AbstractHandler.php : 75

Adds a processor in the stack.

`public pushProcessor(mixed $callback) : self`

##### Parameters

$callback : mixed

##### Return values

self —

#### reset()

AbstractHandler.php : 178
`public reset() : mixed`

##### Return values

mixed —

#### setBubble()

AbstractHandler.php : 149

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()

AbstractHandler.php : 100

Sets the formatter.

`public setFormatter(FormatterInterface $formatter) : self`

##### Parameters

$formatter : FormatterInterface

##### Return values

self —

#### setLevel()

AbstractHandler.php : 125

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

`public setLevel(int|string $level) : self`

##### Parameters

$level : int|string

  Level or level name

##### Return values

self —

#### createHeader()

FirePHPHandler.php : 63

Base header creation function used by init headers & record headers

`protected createHeader(array<string|int, mixed> $meta, string $message) : array<string|int, mixed>`

##### Parameters

$meta : array<string|int, mixed>

  Wildfire Plugin, Protocol & Structure Indexes

$message : string

  Log message

##### Return values

array<string|int, mixed> —

Complete header string ready for the client as key and message as value

#### createRecordHeader()

FirePHPHandler.php : 77

Creates message header from record

`protected createRecordHeader(array<string|int, mixed> $record) : array<string|int, mixed>`

##### Parameters

$record : array<string|int, mixed>

##### Tags

see
  createHeader()

##### Return values

array<string|int, mixed> —

#### getDefaultFormatter()

FirePHPHandler.php : 90

{@inheritDoc}

`protected getDefaultFormatter() : mixed`

##### Return values

mixed —

#### getInitHeaders()

FirePHPHandler.php : 102

Wildfire initialization headers to enable message parsing

`protected getInitHeaders() : array<string|int, mixed>`

##### Tags

see
  createHeader()
see
  sendHeader()

##### Return values

array<string|int, mixed> —

#### headersAccepted()

FirePHPHandler.php : 163

Verifies if the headers are accepted by the current user agent

`protected headersAccepted() : bool`

##### Return values

bool —

#### processRecord()

AbstractProcessingHandler.php : 58

Processes a record.

`protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>`

##### Parameters

$record : array<string|int, mixed>

##### Return values

array<string|int, mixed> —

#### sendHeader()

FirePHPHandler.php : 118

Send header string to the client

`protected sendHeader(string $header, string $content) : mixed`

##### Parameters

$header : string
$content : string

##### Return values

mixed —

#### write()

FirePHPHandler.php : 132

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