AmqpHandler
extends AbstractProcessingHandler
in package
Base Handler class providing the Handler structure, including processors and formatters
Tags
Table of Contents
Properties
- $bubble : bool
- $exchange : AMQPExchange|AMQPChannel
- $exchangeName : string
- $formatter : FormatterInterface|null
- $level : int
- $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
- {@inheritDoc}
- getLevel() : int
- Gets minimum logging level at which this handler will be triggered.
- handle() : bool
- {@inheritDoc}
- handleBatch() : void
- {@inheritDoc}
- isHandling() : bool
- {@inheritDoc}
- popProcessor() : callable
- {@inheritDoc}
- pushProcessor() : HandlerInterface
- {@inheritDoc}
- reset() : void
- setBubble() : self
- Sets the bubbling behavior.
- setExtraAttributes() : AmqpHandler
- Configure extra attributes to pass to the AMQPExchange (if you are using the amqp extension)
- setFormatter() : HandlerInterface
- {@inheritDoc}
- setLevel() : self
- Sets minimum logging level at which this handler will be triggered.
- getDefaultFormatter() : FormatterInterface
- {@inheritDoc}
- getRoutingKey() : string
- Gets the routing key for the AMQP exchange
- processRecord() : array<string|int, mixed>
- Processes a record.
- resetProcessors() : void
- write() : void
- Writes the 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
$level
protected
int
$level
= \Monolog\Logger::DEBUG
Tags
$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 ][, mixed $level = Logger::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 : mixed = Logger::DEBUG
- $bubble : bool = true
__destruct()
public
__destruct() : mixed
__sleep()
public
__sleep() : mixed
close()
Closes the handler.
public
close() : 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.
getExtraAttributes()
public
getExtraAttributes() : array<string, mixed>
Return values
array<string, mixed>getFormatter()
{@inheritDoc}
public
getFormatter() : FormatterInterface
Return values
FormatterInterfacegetLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Tags
Return values
inthandle()
{@inheritDoc}
public
handle(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
boolhandleBatch()
{@inheritDoc}
public
handleBatch(array<string|int, mixed> $records) : void
Parameters
- $records : array<string|int, mixed>
isHandling()
{@inheritDoc}
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
boolpopProcessor()
{@inheritDoc}
public
popProcessor() : callable
Return values
callablepushProcessor()
{@inheritDoc}
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Return values
HandlerInterfacereset()
public
reset() : void
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
selfsetExtraAttributes()
Configure extra attributes to pass to the AMQPExchange (if you are using the amqp extension)
public
setExtraAttributes(array<string, mixed> $extraAttributes) : AmqpHandler
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
AmqpHandlersetFormatter()
{@inheritDoc}
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Return values
HandlerInterfacesetLevel()
Sets minimum logging level at which this handler will be triggered.
public
setLevel(Level|LevelName|LogLevel::* $level) : self
Parameters
- $level : Level|LevelName|LogLevel::*
-
Level or level name
Return values
selfgetDefaultFormatter()
{@inheritDoc}
protected
getDefaultFormatter() : FormatterInterface
Return values
FormatterInterfacegetRoutingKey()
Gets the routing key for the AMQP exchange
protected
getRoutingKey(array<string|int, mixed> $record) : string
Parameters
- $record : array<string|int, mixed>
Tags
Return values
stringprocessRecord()
Processes a record.
protected
processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
- $record : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>resetProcessors()
protected
resetProcessors() : void
write()
Writes the record down to the log of the implementing handler
protected
write(array<string|int, mixed> $record) : void
Parameters
- $record : array<string|int, mixed>
createAmqpMessage()
private
createAmqpMessage(string $data) : AMQPMessage
Parameters
- $data : string