Changeset 1233

Show
Ignore:
Timestamp:
11/04/06 17:04:09 (2 years ago)
Author:
v-dogg
Message:

BREAKING CHANGE! Renamed ambiguously named logging classes (AgaviLayout?, AgaviMessage?, AgaviAppender? and friends), closes #323.

Location:
trunk
Files:
14 modified
8 moved

Legend:

Unmodified
Added
Removed

  • trunk/samples/app/config/logging.xml

    r908 r1233  
    4242 
    4343      <!-- 
    44         Debug logs are rotated in a 7 day (AgaviRotatingFileAppender default) cycle 
     44        Debug logs are rotated in a 7 day (AgaviRotatingFileLoggerAppender default) cycle 
    4545        Use 'cycle' parameter to alter the cycle. 
    4646      --> 
    47       <appender name="DebugLogAppender" class="AgaviRotatingFileAppender" layout="PassthruLayout"> 
     47      <appender name="DebugLogAppender" class="AgaviRotatingFileLoggerAppender" layout="PassthruLayout"> 
    4848        <parameters> 
    4949          <parameter name="dir">%core.app_dir%/log/</parameter> 
    … …  
    5252      </appender> 
    5353 
    54       <appender name="ApplicationLogAppender" class="AgaviFileAppender" layout="PassthruLayout"> 
     54      <appender name="ApplicationLogAppender" class="AgaviFileLoggerAppender" layout="PassthruLayout"> 
    5555        <parameters> 
    5656          <parameter name="file">%core.app_dir%/log/application.log</parameter> 
    … …  
    5858      </appender> 
    5959 
    60       <appender name="ErrorLogAppender" class="AgaviRotatingFileAppender" layout="PassthruLayout"> 
     60      <appender name="ErrorLogAppender" class="AgaviRotatingFileLoggerAppender" layout="PassthruLayout"> 
    6161        <parameters> 
    6262          <parameter name="file">%core.app_dir%/log/error.log</parameter> 
    … …  
    6767 
    6868    <layouts> 
    69       <layout name="PassthruLayout" class="AgaviPassthruLayout" /> 
     69      <layout name="PassthruLayout" class="AgaviPassthruLoggerLayout" /> 
    7070    </layouts> 
    7171 

  • trunk/src/buildtools/code_templates/config/logging.xml

    r908 r1233  
    4242 
    4343      <!-- 
    44         Debug logs are rotated in a 7 day (AgaviRotatingFileAppender default) cycle 
     44        Debug logs are rotated in a 7 day (AgaviRotatingFileLoggerAppender default) cycle 
    4545        Use 'cycle' parameter to alter the cycle. 
    4646      --> 
    47       <appender name="DebugLogAppender" class="AgaviRotatingFileAppender" layout="PassthruLayout"> 
     47      <appender name="DebugLogAppender" class="AgaviRotatingFileLoggerAppender" layout="PassthruLayout"> 
    4848        <parameters> 
    4949          <parameter name="dir">%core.app_dir%/log/</parameter> 
    … …  
    5252      </appender> 
    5353 
    54       <appender name="ApplicationLogAppender" class="AgaviFileAppender" layout="PassthruLayout"> 
     54      <appender name="ApplicationLogAppender" class="AgaviFileLoggerAppender" layout="PassthruLayout"> 
    5555        <parameters> 
    5656          <parameter name="file">%core.app_dir%/log/application.log</parameter> 
    … …  
    5858      </appender> 
    5959 
    60       <appender name="ErrorLogAppender" class="AgaviRotatingFileAppender" layout="PassthruLayout"> 
     60      <appender name="ErrorLogAppender" class="AgaviRotatingFileLoggerAppender" layout="PassthruLayout"> 
    6161        <parameters> 
    6262          <parameter name="file">%core.app_dir%/log/error.log</parameter> 
    … …  
    6767 
    6868    <layouts> 
    69       <layout name="PassthruLayout" class="AgaviPassthruLayout" /> 
     69      <layout name="PassthruLayout" class="AgaviPassthruLoggerLayout" /> 
    7070    </layouts> 
    7171 

  • trunk/src/config/defaults/autoload.xml

    r1227 r1233  
    8989 
    9090      <!-- agavi/logging --> 
    91       <autoload name="AgaviAppender">%core.agavi_dir%/logging/AgaviAppender.class.php</autoload> 
    92       <autoload name="AgaviFileAppender">%core.agavi_dir%/logging/AgaviFileAppender.class.php</autoload> 
    93       <autoload name="AgaviRotatingFileAppender">%core.agavi_dir%/logging/AgaviRotatingFileAppender.class.php</autoload> 
    94       <autoload name="AgaviLayout">%core.agavi_dir%/logging/AgaviLayout.class.php</autoload> 
     91      <autoload name="AgaviLoggerAppender">%core.agavi_dir%/logging/AgaviLoggerAppender.class.php</autoload> 
     92      <autoload name="AgaviFileLoggerAppender">%core.agavi_dir%/logging/AgaviFileLoggerAppender.class.php</autoload> 
     93      <autoload name="AgaviRotatingFileLoggerAppender">%core.agavi_dir%/logging/AgaviRotatingFileLoggerAppender.class.php</autoload> 
     94      <autoload name="AgaviLoggerLayout">%core.agavi_dir%/logging/AgaviLoggerLayout.class.php</autoload> 
    9595      <autoload name="AgaviLogger">%core.agavi_dir%/logging/AgaviLogger.class.php</autoload> 
    9696      <autoload name="AgaviLoggerManager">%core.agavi_dir%/logging/AgaviLoggerManager.class.php</autoload> 
    97       <autoload name="AgaviMessage">%core.agavi_dir%/logging/AgaviMessage.class.php</autoload> 
    98       <autoload name="AgaviPassthruLayout">%core.agavi_dir%/logging/AgaviPassthruLayout.class.php</autoload> 
    99       <autoload name="AgaviStderrAppender">%core.agavi_dir%/logging/AgaviStderrAppender.class.php</autoload> 
    100       <autoload name="AgaviStdoutAppender">%core.agavi_dir%/logging/AgaviStdoutAppender.class.php</autoload> 
     97      <autoload name="AgaviLoggerMessage">%core.agavi_dir%/logging/AgaviLoggerMessage.class.php</autoload> 
     98      <autoload name="AgaviPassthruLoggerLayout">%core.agavi_dir%/logging/AgaviPassthruLoggerLayout.class.php</autoload> 
     99      <autoload name="AgaviStderrLoggerAppender">%core.agavi_dir%/logging/AgaviStderrLoggerAppender.class.php</autoload> 
     100      <autoload name="AgaviStdoutLoggerAppender">%core.agavi_dir%/logging/AgaviStdoutLoggerAppender.class.php</autoload> 
    101101 
    102102      <!-- agavi/model --> 

  • trunk/src/config/defaults/compile.xml

    r1096 r1233  
    3737      <compile>%core.agavi_dir%/filter/AgaviExecutionFilter.class.php</compile> 
    3838      <compile>%core.agavi_dir%/filter/AgaviFilterChain.class.php</compile> 
    39       <compile>%core.agavi_dir%/logging/AgaviAppender.class.php</compile> 
    40       <compile>%core.agavi_dir%/logging/AgaviLayout.class.php</compile> 
     39      <compile>%core.agavi_dir%/logging/AgaviLoggerAppender.class.php</compile> 
     40      <compile>%core.agavi_dir%/logging/AgaviLoggerLayout.class.php</compile> 
    4141      <compile>%core.agavi_dir%/logging/AgaviLogger.class.php</compile> 
    4242      <compile>%core.agavi_dir%/logging/AgaviLoggerManager.class.php</compile> 
    43       <compile>%core.agavi_dir%/logging/AgaviMessage.class.php</compile> 
    44       <compile>%core.agavi_dir%/logging/AgaviPassthruLayout.class.php</compile> 
     43      <compile>%core.agavi_dir%/logging/AgaviLoggerMessage.class.php</compile> 
     44      <compile>%core.agavi_dir%/logging/AgaviPassthruLoggerLayout.class.php</compile> 
    4545      <compile>%core.agavi_dir%/renderer/AgaviRenderer.class.php</compile> 
    4646      <compile>%core.agavi_dir%/request/AgaviRequest.class.php</compile> 

  • trunk/src/logging/AgaviFileLoggerAppender.class.php

    r1094 r1233  
    1515 
    1616/** 
    17  * AgaviFileAppender appends AgaviMessages to a given file. 
     17 * AgaviFileLoggerAppender appends AgaviLoggerMessages to a given file. 
    1818 * 
    1919 * @package    agavi 
    … …  
    2626 * @version    $Id$ 
    2727 */ 
    28 class AgaviFileAppender extends AgaviAppender 
     28class AgaviFileLoggerAppender extends AgaviLoggerAppender 
    2929{ 
    3030  /** 

  • trunk/src/logging/AgaviLogger.class.php

    r1086 r1233  
    7272 
    7373  /** 
    74    * @var        array An array of AgaviAppenders. 
     74   * @var        array An array of AgaviLoggerAppenders. 
    7575   */ 
    7676  protected $appenders = array(); 
    … …  
    8484   * Log a message. 
    8585   * 
    86    * @param      AgaviMessage A Message instance. 
     86   * @param      AgaviLoggerMessage A Message instance. 
    8787   * 
    8888   * @author     Sean Kerr <skerr@mojavi.org> 
    8989   * @since      0.9.0 
    9090   */ 
    91   public function log(AgaviMessage $message) 
     91  public function log(AgaviLoggerMessage $message) 
    9292  { 
    9393    // get message level 
    … …  
    107107   * 
    108108   * @param      string        An appender name. 
    109    * @param      AgaviAppender An Appender instance. 
     109   * @param      AgaviLoggerAppender An Appender instance. 
    110110   * 
    111111   * @throws     <b>AgaviLoggingException</b> If an appender with the name already 
    … …  
    115115   * @since      0.9.0 
    116116   */ 
    117   public function setAppender($name, AgaviAppender $appender) 
     117  public function setAppender($name, AgaviLoggerAppender $appender) 
    118118  { 
    119119    if(!isset($this->appenders[$name])) { 

  • trunk/src/logging/AgaviLoggerAppender.class.php

    r1063 r1233  
    1515 
    1616/** 
    17  * AgaviAppender allows you to specify a destination for log data and provide 
     17 * AgaviLoggerAppender allows you to specify a destination for log data and provide 
    1818 * a custom layout for it, through which all log messages will be formatted. 
    1919 * 
    … …  
    2727 * @version    $Id$ 
    2828 */ 
    29 abstract class AgaviAppender 
     29abstract class AgaviLoggerAppender 
    3030{ 
    3131  /** 
    … …  
    3535 
    3636  /** 
    37    * @var        AgaviLayout An AgaviLayout instance. 
     37   * @var        AgaviLoggerLayout An AgaviLoggerLayout instance. 
    3838   */ 
    3939  protected $layout = null; 
    … …  
    6969   * Retrieve the layout. 
    7070   * 
    71    * @return     AgaviLayout A Layout instance, if it has been set, otherwise null. 
     71   * @return     AgaviLoggerLayout A Layout instance, if it has been set, otherwise null. 
    7272   * 
    7373   * @author     Sean Kerr <skerr@mojavi.org> 
    … …  
    8282   * Set the layout. 
    8383   * 
    84    * @param      AgaviLayout A Layout instance. 
     84   * @param      AgaviLoggerLayout A Layout instance. 
    8585   * 
    86    * @return     AgaviAppender 
     86   * @return     AgaviLoggerAppender 
    8787   * 
    8888   * @author     Sean Kerr <skerr@mojavi.org> 
    8989   * @since      0.9.0 
    9090   */ 
    91   public function setLayout(AgaviLayout $layout) 
     91  public function setLayout(AgaviLoggerLayout $layout) 
    9292  { 
    9393    $this->layout = $layout; 

  • trunk/src/logging/AgaviLoggerLayout.class.php

    r1063 r1233  
    1515 
    1616/** 
    17  * AgaviLayout allows you to specify a message layout for log messages. 
     17 * AgaviLoggerLayout allows you to specify a message layout for log messages. 
    1818 * 
    1919 * @package    agavi 
    … …  
    2626 * @version    $Id$ 
    2727 */ 
    28 abstract class AgaviLayout 
     28abstract class AgaviLoggerLayout 
    2929{ 
    3030  /** 
    … …  
    6868   * Format a message. 
    6969   * 
    70    * @param      AgaviMessage A Message instance. 
     70   * @param      AgaviLoggerMessage A Message instance. 
    7171   * 
    7272   * @return     string A formatted message. 
    … …  
    7575   * @since      0.9.0 
    7676   */ 
    77   abstract function format(AgaviMessage $message); 
     77  abstract function format(AgaviLoggerMessage $message); 
    7878 
    7979  /** 

  • trunk/src/logging/AgaviLoggerManager.class.php

    r1063 r1233  
    180180   * Log a Message. 
    181181   * 
    182    * @param      AgaviMessage The Message to log. 
     182   * @param      AgaviLoggerMessage The Message to log. 
    183183   * @param      string Optional logger to log to. 
    184184   * 
    … …  
    189189   * @since      0.10.0 
    190190   */ 
    191   public function log(AgaviMessage $message, $logger = null) 
     191  public function log(AgaviLoggerMessage $message, $logger = null) 
    192192  { 
    193193    if(is_null($logger)) { 

  • trunk/src/logging/AgaviLoggerMessage.class.php

    r1087 r1233  
    1515 
    1616/** 
    17  * AgaviMessage, by default, holds a message and a priority level. 
     17 * AgaviLoggerMessage, by default, holds a message and a priority level. 
    1818 * It is intended to be passed to a AgaviLogger. 
    1919 * 
    … …  
    2727 * @version    $Id$ 
    2828 */ 
    29 class AgaviMessage extends AgaviParameterHolder 
     29class AgaviLoggerMessage extends AgaviParameterHolder 
    3030{ 
    3131  /** 
    … …  
    6262   * @param      string The message to set. 
    6363   * 
    64    * @return     AgaviMessage 
     64   * @return     AgaviLoggerMessage 
    6565   * 
    6666   * @author     Bob Zoller <bob@agavi.org> 
    … …  
    7878   * @param      string Message to append. 
    7979   * 
    80    * @return     AgaviMessage 
     80   * @return     AgaviLoggerMessage 
    8181   * 
    8282   * @author     Bob Zoller <bob@agavi.org> 

  • trunk/src/logging/AgaviPassthruLoggerLayout.class.php

    r1063 r1233  
    1515 
    1616/** 
    17  * AgaviPassthruLayout is an AgaviLayout that will return the AgaviMessage text  
     17 * AgaviPassthruLoggerLayout is an AgaviLoggerLayout that will return the AgaviLoggerMessage text 
    1818 * unaltered. 
    1919 * 
    … …  
    2727 * @version    $Id$ 
    2828 */ 
    29 class AgaviPassthruLayout extends AgaviLayout 
     29class AgaviPassthruLoggerLayout extends AgaviLoggerLayout 
    3030{ 
    3131  /** 
    3232   * Format a message. 
    3333   * 
    34    * @param      AgaviMessage A AgaviMessage instance. 
     34   * @param      AgaviLoggerMessage A AgaviLoggerMessage instance. 
    3535   * 
    3636   * @return     string A formatted message. 
    … …  
    3939   * @since      0.10.0 
    4040   */ 
    41   public function format(AgaviMessage $message) 
     41  public function format(AgaviLoggerMessage $message) 
    4242  { 
    4343    return $message->__toString(); 

  • trunk/src/logging/AgaviRotatingFileLoggerAppender.class.php

    r1094 r1233  
    1414 
    1515/** 
    16  * AgaviRotatingFileAppender extends AgaviFileAppender by enabling per-day log files 
     16 * AgaviRotatingFileLoggerAppender extends AgaviFileLoggerAppender by enabling per-day log files 
    1717 * and removing unwanted old log files. 
    1818 * 
    … …  
    3636 * @version    $Id$ 
    3737 */ 
    38 class AgaviRotatingFileAppender extends AgaviFileAppender 
     38class AgaviRotatingFileLoggerAppender extends AgaviFileLoggerAppender 
    3939{ 
    4040  /** 

  • trunk/src/logging/AgaviStderrLoggerAppender.class.php

    r1094 r1233  
    1515 
    1616/** 
    17  * AgaviStderrAppender appends an AgaviMessages to the stderr. 
     17 * AgaviStderrLoggerAppender appends an AgaviLoggerMessages to the stderr. 
    1818 * 
    1919 * @package    agavi 
    … …  
    2626 * @version    $Id$ 
    2727 */ 
    28 class AgaviStderrAppender extends AgaviFileAppender 
     28class AgaviStderrLoggerAppender extends AgaviFileLoggerAppender 
    2929{ 
    3030  /** 

  • trunk/src/logging/AgaviStdoutLoggerAppender.class.php

    r1094 r1233  
    1515 
    1616/** 
    17  * AgaviStdoutAppender appends an AgaviMessage to stdout. 
     17 * AgaviStdoutLoggerAppender appends an AgaviLoggerMessage to stdout. 
    1818 * 
    1919 * @package    agavi 
    … …  
    2626 * @version    $Id$ 
    2727 */ 
    28 class AgaviStdoutAppender extends AgaviFileAppender 
     28class AgaviStdoutLoggerAppender extends AgaviFileLoggerAppender 
    2929{ 
    3030  /** 

  • trunk/tests2/config/LoggingConfigHandlerTest.php

    r1175 r1233  
    99  public $level; 
    1010 
    11   public function setAppender($name, AgaviAppender $appender) 
     11  public function setAppender($name, AgaviLoggerAppender $appender) 
    1212  { 
    1313    $this->appenders[$name] = $appender; 
    … …  
    2424class TestLogger3 extends TestLogger { } 
    2525 
    26 class TestAppender extends AgaviAppender 
     26class TestAppender extends AgaviLoggerAppender 
    2727{ 
    2828  public $params = null; 
    … …  
    3434  } 
    3535 
    36   public function setLayout(AgaviLayout $layout) 
     36  public function setLayout(AgaviLoggerLayout $layout) 
    3737  { 
    3838    $this->layout = $layout; 
    … …  
    4747class TestAppender3 extends TestAppender { } 
    4848 
    49 class TestLayout extends AgaviLayout 
     49class TestLayout extends AgaviLoggerLayout 
    5050{ 
    5151  public $params = null; 
    … …  
    5555    $this->params = $params; 
    5656  } 
    57   public function format(AgaviMessage $message) {} 
     57  public function format(AgaviLoggerMessage $message) {} 
    5858} 
    5959 

  • trunk/tests2/logging/AppenderTest.php

    r1063 r1233  
    11<?php 
    22 
    3 class Sample2Layout extends AgaviLayout 
     3class Sample2Layout extends AgaviLoggerLayout 
    44{ 
    5   public function format(AgaviMessage $message){} 
     5  public function format(AgaviLoggerMessage $message){} 
    66} 
    77 
    8 class SampleAppender extends AgaviAppender 
     8class SampleAppender extends AgaviLoggerAppender 
    99{ 
    1010  public function initialize(AgaviContext $context, array $params = array()) {} 

  • trunk/tests2/logging/FileAppenderTest.php

    r908 r1233  
    1010    $this->_file = tempnam('', 'FOO'); 
    1111    unlink($this->_file); 
    12     $this->_fa = new AgaviFileAppender(); 
     12    $this->_fa = new AgaviFileLoggerAppender(); 
    1313    $this->_fa->initialize($this->_context, array('file'=>$this->_file)); 
    14     $this->_fa->setLayout(new AgaviPassthruLayout()); 
     14    $this->_fa->setLayout(new AgaviPassthruLoggerLayout()); 
    1515  } 
    16    
     16 
    1717  public function tearDown() 
    1818  { 
    … …  
    2323  { 
    2424    $this->assertFalse(file_exists($this->_file)); 
    25     $this->_fa->write(new AgaviMessage('my message')); 
     25    $this->_fa->write(new AgaviLoggerMessage('my message')); 
    2626    $this->assertTrue(file_exists($this->_file)); 
    2727    $this->_fa->shutdown(); 
    … …  
    3030  public function testwrite() 
    3131  { 
    32     $this->_fa->write(new AgaviMessage('my message')); 
     32    $this->_fa->write(new AgaviLoggerMessage('my message')); 
    3333    $this->assertRegexp('/my message/', file_get_contents($this->_file)); 
    3434    $this->_fa->shutdown(); 

  • trunk/tests2/logging/LayoutTest.php

    r1063 r1233  
    11<?php 
    22 
    3 class SampleLayout extends AgaviLayout 
     3class SampleLayout extends AgaviLoggerLayout 
    44{ 
    5   public function format(AgaviMessage $message){} 
     5  public function format(AgaviLoggerMessage $message){} 
    66} 
    77 

  • trunk/tests2/logging/LoggerManagerTest.php

    r908 r1233  
    2222    @unlink($this->_logfile); 
    2323    @unlink($this->_logfile2); 
    24     $this->_pl = new AgaviPassthruLayout; 
    25     $this->_fa = new AgaviFileAppender; 
     24    $this->_pl = new AgaviPassthruLoggerLayout; 
     25    $this->_fa = new AgaviFileLoggerAppender; 
    2626    $this->_fa->initialize($this->_context, array('file' => $this->_logfile)); 
    2727    $this->_fa->setLayout($this->_pl); 
    28     $this->_fa2 = new AgaviFileAppender; 
     28    $this->_fa2 = new AgaviFileLoggerAppender; 
    2929    $this->_fa2->initialize($this->_context, array('file' => $this->_logfile2)); 
    3030    $this->_fa2->setLayout($this->_pl); 
    … …  
    7272 
    7373    //this should be logged by both 
    74     $this->_lm->log(new AgaviMessage('simple info message', AgaviLogger::INFO)); 
     74    $this->_lm->log(new AgaviLoggerMessage('simple info message', AgaviLogger::INFO)); 
    7575    $this->assertRegexp('/simple info message/', file_get_contents($this->_logfile)); 
    7676    $this->assertRegexp('/simple info message/', file_get_contents($this->_logfile2)); 
    7777 
    7878    //this should be logged only by l2