1
0
mirror of https://github.com/Seldaek/monolog.git synced 2025-10-22 17:16:18 +02:00

Added a BufferHandler to allow batch processing of the records

This commit is contained in:
Christophe Coevoet
2011-04-05 09:41:27 +02:00
parent b90eddd513
commit b2d356bbf2
4 changed files with 154 additions and 0 deletions

View File

@@ -0,0 +1,72 @@
<?php
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Handler;
use Monolog\Logger;
/**
* Buffers all records until closing the handler and then pass them as batch.
*
* This is useful for a MailHandler to send only one mail per request instead of
* sending one per log message.
*
* @author Christophe Coevoet <stof@notk.org>
*/
class BufferHandler extends AbstractHandler
{
protected $handler;
protected $bufferSize;
protected $buffer = array();
/**
* @param HandlerInterface $handler Handler.
* @param int $bufferSize How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.
* @param Boolean $bubble
*/
public function __construct(HandlerInterface $handler, $bufferSize = 0, $bubble = false)
{
$this->handler = $handler;
$this->bufferSize = $bufferSize;
$this->bubble = $bubble;
}
/**
* Handles a record
*
* Records are buffered until closing the handler.
*
* @param array $record Records
* @return Boolean Whether the record was handled
*/
public function handle(array $record)
{
$this->buffer[] = $record;
if ($this->bufferSize > 0 && count($this->buffer) > $this->bufferSize) {
array_shift($this->buffer);
}
return false === $this->bubble;
}
public function close()
{
$this->handler->handleBatch($this->buffer);
}
/**
* Implemented to comply with the AbstractHandler requirements. Can not be called.
*/
public function write(array $record)
{
throw new \BadMethodCallException('This method should not be called directly on the FingersCrossedHandler.');
}
}