AmqpHandler
extends AbstractProcessingHandler
in package
Base Handler class providing the Handler structure, including processors and formatters
Classes extending it should (in most cases) only implement write($record)
Table of Contents
Properties
- $bubble : bool
- $exchange : AMQPExchange|AMQPChannel
- $exchangeName : string
- $formatter : FormatterInterface|null
- $level : Level
- $processors : array<string|int, callable>
- $extraAttributes : array<string, mixed>
Methods
- __construct() : mixed
- __destruct() : mixed
- __sleep() : mixed
- close() : void
- Closes the handler.
- getBubble() : bool
- Gets the bubbling behavior.
- getExtraAttributes() : array<string, mixed>
- 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.
- setExtraAttributes() : $this
- Configure extra attributes to pass to the AMQPExchange (if you are using the amqp extension)
- setFormatter() : HandlerInterface
- setLevel() : $this
- Sets minimum logging level at which this handler will be triggered.
- getDefaultFormatter() : FormatterInterface
- getRoutingKey() : string
- Gets the routing key for the AMQP exchange
- processRecord() : LogRecord
- resetProcessors() : void
- write() : void
- Writes the (already formatted) record down to the log of the implementing handler
- createAmqpMessage() : AMQPMessage
Properties
$bubble
protected
bool
$bubble
= true
$exchange
protected
AMQPExchange|AMQPChannel
$exchange
$exchangeName
protected
string
$exchangeName
$formatter
protected
FormatterInterface|null
$formatter
= null
$level
protected
Level
$level
= \Monolog\Level::Debug
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$extraAttributes
private
array<string, mixed>
$extraAttributes
= []
Methods
__construct()
public
__construct(AMQPExchange|AMQPChannel $exchange[, string|null $exchangeName = null ][, int|string|Level $level = Level::Debug ][, bool $bubble = true ]) : mixed
Parameters
- $exchange : AMQPExchange|AMQPChannel
-
AMQPExchange (php AMQP ext) or PHP AMQP lib channel, ready for use
- $exchangeName : string|null = null
-
Optional exchange name, for AMQPChannel (PhpAmqpLib) only
- $level : int|string|Level = 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
__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.
getExtraAttributes()
public
getExtraAttributes() : array<string, mixed>
Return values
array<string, mixed>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
$thissetExtraAttributes()
Configure extra attributes to pass to the AMQPExchange (if you are using the amqp extension)
public
setExtraAttributes(array<string, mixed> $extraAttributes) : $this
Parameters
- $extraAttributes : array<string, mixed>
-
One of content_type, content_encoding, message_id, user_id, app_id, delivery_mode, priority, timestamp, expiration, type or reply_to, headers.
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
$thisgetDefaultFormatter()
protected
getDefaultFormatter() : FormatterInterface
Tags
Return values
FormatterInterfacegetRoutingKey()
Gets the routing key for the AMQP exchange
protected
getRoutingKey(LogRecord $record) : string
Parameters
- $record : LogRecord
Return values
stringprocessRecord()
protected
processRecord(LogRecord $record) : LogRecord
Parameters
- $record : LogRecord
Return values
LogRecordresetProcessors()
protected
resetProcessors() : void
write()
Writes the (already formatted) record down to the log of the implementing handler
protected
write(LogRecord $record) : void
Parameters
- $record : LogRecord
Tags
createAmqpMessage()
private
createAmqpMessage(string $data) : AMQPMessage
Parameters
- $data : string