interface/modules/zend_modules/library/Zend/Log/Formatter/FormatterInterface.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\Formatter;
  11
  12 interface FormatterInterface
  13 {
  14     /**
  15      * Default format specifier for DateTime objects is ISO 8601
  16      *
  17      * @see http://php.net/manual/en/function.date.php
  18      */
  19     const DEFAULT_DATETIME_FORMAT = 'c';
  20
  21     /**
  22      * Formats data into a single line to be written by the writer.
  23      *
  24      * @param array $event event data
  25      * @return string formatted line to write to the log
  26      */
  27     public function format($event);
  28
  29     /**
  30      * Get the format specifier for DateTime objects
  31      *
  32      * @return string
  33      */
  34     public function getDateTimeFormat();
  35
  36     /**
  37      * Set the format specifier for DateTime objects
  38      *
  39      * @see http://php.net/manual/en/function.date.php
  40      * @param string $dateTimeFormat DateTime format
  41      * @return FormatterInterface
  42      */
  43     public function setDateTimeFormat($dateTimeFormat);
  44 }