Alpha Framework alpha--util
[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]

Class: Logger

Source Location: /util/Logger.inc

Class Logger

Class Overview

Log class used for debug and exception logging

Located in /util/Logger.inc [line 55]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: Logger.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
Logger   __construct()   The constructor
void   debug()   Log a DEBUG message
void   error()   Log an ERROR message
void   fatal()   Log a FATAL message
void   info()   Log an INFO message
void   notifyAdmin()   Notify the sys admin via email when a serious error occurs
void   setLogFile()   Allows you to set the log file path to one other than the main application log.
void   sql()   Log a SQL queries
void   warn()   Log a WARN message

[ Top ]
Methods
Constructor __construct  [line 94]

  Logger __construct( string $classname  )

The constructor

Parameters:
string   $classname: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
debug  [line 110]

  void debug( string $message  )

Log a DEBUG message

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
error  [line 152]

  void error( string $message  )

Log an ERROR message

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
fatal  [line 167]

  void fatal( string $message  )

Log a FATAL message

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
info  [line 124]

  void info( string $message  )

Log an INFO message

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
notifyAdmin  [line 196]

  void notifyAdmin( string $message  )

Notify the sys admin via email when a serious error occurs

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setLogFile  [line 219]

  void setLogFile( string $filepath  )

Allows you to set the log file path to one other than the main application log.

Parameters:
string   $filepath: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
sql  [line 182]

  void sql( string $message  )

Log a SQL queries

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.1

[ Top ]
warn  [line 138]

  void warn( string $message  )

Log a WARN message

Parameters:
string   $message: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:12 +0000 by phpDocumentor 1.4.3