Plop\HandlerInterface Interface Reference
Interface for a class capable of handling log records. More...
Inheritance diagram for Plop\HandlerInterface:
Public Member Functions | |
| getFilters () | |
| getFormatter () | |
| handle (\Plop\RecordInterface $record) | |
| handleError (\Plop\RecordInterface $record,\Exception $exception) | |
| setFilters (\Plop\FiltersCollectionAbstract $filters) | |
| setFormatter (\Plop\FormatterInterface $formatter) | |
Detailed Description
Interface for a class capable of handling log records.
Definition at line 27 of file HandlerInterface.php.
Member Function Documentation
| Plop\HandlerInterface::getFilters | ( | ) |
Get the collection of filters currently associated with this handler.
- Return values
-
Plop::FiltersCollectionAbstract Collection of filters associated with this handler.
Implemented in Plop\HandlerAbstract.
| Plop\HandlerInterface::getFormatter | ( | ) |
Return the formatter used by this handler.
- Return values
-
Plop::FormatterInterface Formatter object used by this handler.
Implemented in Plop\HandlerAbstract.
| Plop\HandlerInterface::handle | ( | \Plop\RecordInterface | $record | ) |
Handle a log record.
- Parameters
-
Plop::RecordInterface $record The log record to handle.
- Return values
-
Plop::HandlerInterface The handler instance (ie. $this).
Implemented in Plop\HandlerAbstract.
| Plop\HandlerInterface::handleError | ( | \Plop\RecordInterface | $record, |
| \Exception | $exception | ||
| ) |
Handle an exception that occurred during log record handling.
- Parameters
-
Plop::RecordInterface $record The log record that was being handled when the exception occurred. Exception $exception The actual exception.
- Return values
-
Plop::HandlerInterface The handler instance (ie. $this).
Implemented in Plop\Handler\Socket, and Plop\HandlerAbstract.
| Plop\HandlerInterface::setFilters | ( | \Plop\FiltersCollectionAbstract | $filters | ) |
Set the collection of filters associated with this handler.
- Parameters
-
Plop::FiltersCollectionAbstract $filters New collection of filters to associate with this handler.
- Return values
-
Plop::HandlerInterface The handler instance (ie. $this).
Implemented in Plop\HandlerAbstract.
| Plop\HandlerInterface::setFormatter | ( | \Plop\FormatterInterface | $formatter | ) |
Set the new formatter to use.
- Parameters
-
Plop::FormatterInterface $formatter The new formatter object to use to format log records.
- Return values
-
Plop::HandlerInterface The handler instance (ie. $this).
Implemented in Plop\HandlerAbstract.
The documentation for this interface was generated from the following file:
