common.logger.appender
[ class tree: common.logger.appender ] [ index: common.logger.appender ] [ all elements ]
Packages:
default
common.cache
common.container
common.controller.flow
common.datasource
common.datastructure
common.helper.dsn
common.logger
common.logger.appender
common.logger.layout
common.reader
common.storage
common.validator
Mojavi
mvc.controller
package.loader


Files:
Appender.class.php
FileAppender.class.php

Classes:
Appender
FileAppender

Class: Appender

Source Location: /logger/appender/Appender.class.php

Class Overview




Appender allows you to log exceptions to any location.




Author(s):


    
                      
  • Simon Schmid (original by Sean Kerr)
    • 
      





            








Methods















Child classes:






FileAppender

	
FileAppender writes a exception into a file.

















Class Details



[line 19]

Appender allows you to log exceptions to any location.





Tags:





  

    abstract:  
  

  

    since:  2.0  $Id$
  

  

    author:  Simon Schmid (original by Sean Kerr)
  










[ Top ]








Class Methods



  

	
	
constructor __construct [line 40]

	

    

    

		Appender __construct(
Layout
$layout)
    

    


	
		Create a new Appender instance.





Tags:





  

    access:  public
  

  

    since:  2.0
  









	
Overridden in child classes as:

		

	
FileAppender::__construct()

		
Create a new FileAppender instance.

	

	


        
Parameters:

    

    

          

        Layout  
        $layout  
        A Layout instance.
      

        

    


        
[ Top ]

  

  

	
	
destructor __destruct [line 111]

	

    

    

		void __destruct(
)
    

    


	
		Cleanup appender resources if any exist.



<note>      This should never be called manually.  </note>





Tags:





  

    access:  public
  

  

    abstract:  
  

  

    since:  2.0
  









	
Overridden in child classes as:

		

	
FileAppender::__destruct()

		
Close the file pointer.

	

	


        
[ Top ]

  

  

	
	
method getLayout [line 56]

	

    

    

		Layout &getLayout(
)
    

    


	
		Retrieve the layout this appender is using.





Tags:





  

    return:  A Layout instance.
  

  

    access:  public
  

  

    since:  2.0
  










        
[ Top ]

  

  

	
	
method setLayout [line 72]

	

    

    

		void setLayout(
Layout
$layout)
    

    


	
		Set the layout this appender will use.





Tags:





  

    access:  public
  

  

    since:  2.0
  










        
Parameters:

    

    

          

        Layout  
        $layout  
        A Layout instance.
      

        

    


        
[ Top ]

  

  

	
	
method write [line 95]

	

    

    

		void write(
exception
$e)
    

    


	
		Write to this appender.



<note>      This should never be called manually.  </note>





Tags:





  

    access:  public
  

  

    abstract:  
  

  

    since:  2.0
  









	
Overridden in child classes as:

		

	
FileAppender::write()

		
Write an exception to the log file.

	

	


        
Parameters:

    

    

          

        exception  
        $e  
        The exception to write.
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 21 Feb 2006 02:29:37 +0900 by phpDocumentor 1.3.0RC5