[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * log4php is a PHP port of the log4j java logging package.
   4   * 
   5   * <p>This framework is based on log4j (see {@link http://jakarta.apache.org/log4j log4j} for details).</p>
   6   * <p>Design, strategies and part of the methods documentation are developed by log4j team 
   7   * (Ceki G�lc� as log4j project founder and 
   8   * {@link http://jakarta.apache.org/log4j/docs/contributors.html contributors}).</p>
   9   *
  10   * <p>PHP port, extensions and modifications by VxR. All rights reserved.<br>
  11   * For more information, please see {@link http://www.vxr.it/log4php/}.</p>
  12   *
  13   * <p>This software is published under the terms of the LGPL License
  14   * a copy of which has been included with this distribution in the LICENSE file.</p>
  15   * 
  16   * @package log4php
  17   */
  18  
  19  /**
  20   * @ignore 
  21   */
  22  if (!defined('LOG4PHP_DIR')) define('LOG4PHP_DIR', dirname(__FILE__)); 
  23  
  24  /**
  25   * Extend this abstract class to create your own log layout format.
  26   *  
  27   * @author VxR <[email protected]>
  28   * @version $Revision: 1.10 $
  29   * @package log4php
  30   * @abstract
  31   */
  32  class LoggerLayout {
  33  
  34      /**
  35       * Creates LoggerLayout instances with the given class name.
  36       *
  37       * @param string $class
  38       * @return LoggerLayout
  39       */
  40      function factory($class)
  41      {
  42          if (!empty($class)) {
  43              $class = basename($class);
  44              if (!class_exists($class))
  45                  @include_once(LOG4PHP_DIR . "/layouts/{$class}.php");
  46              if (class_exists($class))
  47                  return new $class();
  48          }
  49          return null;
  50      }
  51  
  52      /**
  53       * Override this method
  54       */
  55      function activateOptions() 
  56      {
  57          // override;
  58      }
  59  
  60      /**
  61       * Override this method to create your own layout format.
  62       *
  63       * @param LoggerLoggingEvent
  64       * @return string
  65       */
  66      function format($event)
  67      {
  68          return $event->getRenderedMessage();
  69      } 
  70      
  71      /**
  72       * Returns the content type output by this layout.
  73       * @return string
  74       */
  75      function getContentType()
  76      {
  77          return "text/plain";
  78      } 
  79              
  80      /**
  81       * Returns the footer for the layout format.
  82       * @return string
  83       */
  84      function getFooter()
  85      {
  86          return null;
  87      } 
  88  
  89      /**
  90       * Returns the header for the layout format.
  91       * @return string
  92       */
  93      function getHeader()
  94      {
  95          return null;
  96      }
  97  }
  98  ?>