interface/modules/zend_modules/library/Zend/Log/Writer/WriterInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Log\Writer;
  11
  12 use Zend\Log\Filter\FilterInterface as Filter;
  13 use Zend\Log\Formatter\FormatterInterface as Formatter;
  14
  15 interface WriterInterface
  16 {
  17     /**
  18      * Add a log filter to the writer
  19      *
  20      * @param  int|string|Filter $filter
  21      * @return WriterInterface
  22      */
  23     public function addFilter($filter);
  24
  25     /**
  26      * Set a message formatter for the writer
  27      *
  28      * @param string|Formatter $formatter
  29      * @return WriterInterface
  30      */
  31     public function setFormatter($formatter);
  32
  33     /**
  34      * Write a log message
  35      *
  36      * @param  array $event
  37      * @return WriterInterface
  38      */
  39     public function write(array $event);
  40
  41     /**
  42      * Perform shutdown activities
  43      *
  44      * @return void
  45      */
  46     public function shutdown();
  47 }