# Class Logger

Log class used for debug and exception logging

Package: alpha::util
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Logger.inc 1668 2013-09-12 20:30:36Z alphadevx $
Since: 1.0
Located at util/Logger.inc

Methods summary
`public` | # `__construct( string $classname )` The constructor The constructor #### Parameters $classname `string` $classname #### Since 1.0
`public` | # `debug( string $message )` Log a DEBUG message Log a DEBUG message #### Parameters $message `string` $message #### Since 1.0
`public` | # `info( string $message )` Log an INFO message Log an INFO message #### Parameters $message `string` $message #### Since 1.0
`public` | # `warn( string $message )` Log a WARN message Log a WARN message #### Parameters $message `string` $message #### Since 1.0
`public` | # `error( string $message )` Log an ERROR message Log an ERROR message #### Parameters $message `string` $message #### Since 1.0
`public` | # `fatal( string $message )` Log a FATAL message Log a FATAL message #### Parameters $message `string` $message #### Since 1.0
`public` | # `sql( string $message )` Log a SQL queries Log a SQL queries #### Parameters $message `string` $message #### Since 1.1
`public` | # `action( string $message )` Log an action carried out by a person to the ActionLog table Log an action carried out by a person to the ActionLog table #### Parameters $message `string` $message #### Since 1.1
`public` | # `notifyAdmin( string $message )` Notify the sys admin via email when a serious error occurs Notify the sys admin via email when a serious error occurs #### Parameters $message `string` $message #### Since 1.0
`public` | # `setLogFile( string $filepath )` Allows you to set the log file path to one other than the main application log. Allows you to set the log file path to one other than the main application log. #### Parameters $filepath `string` $filepath #### Since 1.0

Properties summary
`private `LogFile`` | $logfile | `` | # The log file the log entries will be saved to The log file the log entries will be saved to #### Since 1.0
`private string` | $level | `` | # The logging level applied accross the system. Valid options are DEBUG, INFO, WARN, ERROR, FATAL, and SQL The logging level applied accross the system. Valid options are DEBUG, INFO, WARN, ERROR, FATAL, and SQL #### Since 1.0
`private string` | $classname | `` | # The name of the class that this Logger is logging for The name of the class that this Logger is logging for #### Since 1.0
`private array` | $debugClasses | `array()` | # An array of class names that will be logged at debug level, regardless of the global Logger::level setting An array of class names that will be logged at debug level, regardless of the global Logger::level setting #### Since 1.0