, mosen
* This file is part of AjaXplorer.
*
* AjaXplorer is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* AjaXplorer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with AjaXplorer. If not, see .
*
* The latest code can be found at .
*/
defined('AJXP_EXEC') or die( 'Access not allowed');
if(!defined('LOG_LEVEL_DEBUG')){
define("LOG_LEVEL_DEBUG", "Debug");
define("LOG_LEVEL_INFO", "Info");
define("LOG_LEVEL_NOTICE", "Notice");
define("LOG_LEVEL_WARNING", "Warning");
define("LOG_LEVEL_ERROR", "Error");
}
/**
* @package info.ajaxplorer.log
* @class AbstractLogDriver
* @author mosen
* @abstract
* Abstraction of the logging system
* The output stream/file/device will be implemented by the plugin which extends this class.
* The object has a chance to open its stream or file from the init() method. all subsequent calls assume
* the availability of the stream or file.
*/
class AbstractLogDriver extends AJXP_Plugin {
/**
* Driver type
*
* @var String type of driver
*/
var $driverType = "log";
/**
* Initialise the driver.
*
* Gives the driver a chance to set up it's connection / file resource etc..
*
* @param Array $options array of options specific to the logger driver.
* @access public
*/
function init($options) {}
/**
* Write an entry to the log.
*
* @param String $textMessage The message to log
* @param String $severityLevel The severity level, see LOG_LEVEL_ constants
*
*/
function write($textMessage, $severityLevel = LOG_LEVEL_DEBUG) {}
/**
* Format an array as a readable string
*
* Base implementation which can be used by other loggers to format arrays of parameters
* nicely.
*
* @param Array $params
* @return String readable list of parameters.
*/
function arrayToString($params){
$st = "";
$index=0;
foreach ($params as $key=>$value){
$index++;
if(!is_numeric($key)){
$st.="$key=";
}
if(is_string($value) || is_numeric($value)){
$st.=$value;
}else if(is_array($value)){
$st.=$this->arrayToString($value);
}else if(is_bool($value)){
$st.=($value?"true":"false");
}else if(is_a($value, "UserSelection")){
$st.=$this->arrayToString($value->getFiles());
}
if($index < count($params)){
if(is_numeric($key)){
$st.=",";
}else{
$st.=";";
}
}
}
return $st;
}
/**
* List available log files in XML
*
* @param String [optional] $nodeName
* @param String [optional] $year
* @param String [optional] $month
*/
function xmlListLogFiles($nodeName="file", $year=null, $month=null, $rootPath = "/logs"){}
/**
* List log contents in XML
*
* @param String $date Assumed to be m-d-y format.
* @param String [optional] $nodeName
*/
function xmlLogs($parentDir, $date, $nodeName = "log", $rootPath = "/logs"){}
}