\Monolog\HandlerAmqpHandler

Base Handler class providing the Handler structure

Classes extending it should (in most cases) only implement write($record)

Summary

Methods
Properties
Constants
handle()
__construct()
isHandling()
handleBatch()
close()
pushProcessor()
popProcessor()
setFormatter()
getFormatter()
setLevel()
getLevel()
setBubble()
getBubble()
__destruct()
No public properties found
No constants found
write()
processRecord()
getDefaultFormatter()
getRoutingKey()
$level
$bubble
$formatter
$processors
$exchange
$exchangeName
N/A
createAmqpMessage()
No private properties found
N/A

Properties

$level

$level : 

Type

$bubble

$bubble : 

Type

$processors

$processors : 

Type

$exchange

$exchange : \AMQPExchange|\PhpAmqpLib\Channel\AMQPChannel

Type

\AMQPExchange|\PhpAmqpLib\Channel\AMQPChannel

$exchangeName

$exchangeName : string

Type

string

Methods

handle()

handle(array  $record) 

{@inheritdoc}

Parameters

array $record

__construct()

__construct(\AMQPExchange|\PhpAmqpLib\Channel\AMQPChannel  $exchange, string  $exchangeName = 'log', integer  $level = \Monolog\Logger::DEBUG, boolean  $bubble = true) 

Parameters

\AMQPExchange|\PhpAmqpLib\Channel\AMQPChannel $exchange

AMQPExchange (php AMQP ext) or PHP AMQP lib channel, ready for use

string $exchangeName
integer $level
boolean $bubble

Whether the messages that are handled can bubble up the stack or not

isHandling()

isHandling(array  $record) : Boolean

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

This is mostly done for performance reasons, to avoid calling processors for nothing.

Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record

Partial log record containing only a level key

Returns

Boolean

handleBatch()

handleBatch(array  $records) 

{@inheritDoc}

Parameters

array $records

close()

close() 

Closes the handler.

This will be called automatically when the object is destroyed

pushProcessor()

pushProcessor(callable  $callback) : self

Adds a processor in the stack.

Parameters

callable $callback

Returns

self

popProcessor()

popProcessor() : callable

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

Returns

callable

setLevel()

setLevel(integer|string  $level) : self

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

Parameters

integer|string $level

Level or level name

Returns

self

getLevel()

getLevel() : integer

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

Returns

integer

setBubble()

setBubble(Boolean  $bubble) : self

Sets the bubbling behavior.

Parameters

Boolean $bubble

true means that this handler allows bubbling. false means that bubbling is not permitted.

Returns

self

getBubble()

getBubble() : Boolean

Gets the bubbling behavior.

Returns

Boolean —

true means that this handler allows bubbling. false means that bubbling is not permitted.

__destruct()

__destruct() 

write()

write(array  $record) : void

Writes the record down to the log of the implementing handler

Parameters

array $record

processRecord()

processRecord(array  $record) : array

Processes a record.

Parameters

array $record

Returns

array

getDefaultFormatter()

getDefaultFormatter() 

{@inheritDoc}

getRoutingKey()

getRoutingKey(array  $record) : string

Gets the routing key for the AMQP exchange

Parameters

array $record

Returns

string

createAmqpMessage()

createAmqpMessage(string  $data) : \PhpAmqpLib\Message\AMQPMessage

Parameters

string $data

Returns

\PhpAmqpLib\Message\AMQPMessage