fwolf / fwlib

class/fwolflib.php

<?php
/**
 * @package		fwolflib
 * @subpackage	class
 * @copyright	Copyright © 2010, Fwolf
 * @author		Fwolf <fwolf.aide+fwolflib.class@gmail.com>
 * @since		2010-01-30
 */


require_once(dirname(__FILE__) . '/../fwolflib.php');
require_once(FWOLFLIB . 'func/env.php');


/**
 * Basic class of all.
 *
 * Log included.
 *
 * @deprecated  Use classes in Fwlib namespace, see PSR-0/1/2
 * @package		fwolflib
 * @subpackage	class
 * @copyright	Copyright © 2010, Fwolf
 * @author		Fwolf <fwolf.aide+fwolflib.class@gmail.com>
 * @since		2010-01-30
 */
class Fwolflib {

	/**
	 * Configuation
	 *
	 * Notice: re-define var in sub-class will overwrite var in parent class.
	 * @var	array
	 */
	public $aCfg = array();

	/**
	 * Default time format
	 * @var	string
	 */
	public $sFormatTime = 'Y-m-d H:i:s';

	/**
	 * Log msg.
	 *
	 * Log level 5(or 4) can be used as error or warning.
	 *
	 * array(
	 * 	i	=> array(
	 * 		level	=> 1/notice, 3/common, 5/imortant
	 * 			Can also be 2 or 4, even 1.5(not suggested),
	 * 			Default is 3.
	 * 		time	=>
	 * 		msg		=>
	 * 	)
	 * )
	 *
	 * @var	array
	 */
	public $aLog = array();


	/**
	 * constructor
	 *
	 * @param	array	$ar_cfg
	 */
	public function __construct ($ar_cfg = array()) {
		$this->SetCfgDefault();
		if (!empty($ar_cfg))
			$this->SetCfg($ar_cfg);
		$this->Init();
	} // end of func __construct


	/**
	 * Dummy destructor
	 */
	public function __destruct () {
	} // end of func __destruct


	/**
	 * Auto new obj if not set, for some special var only
	 *
	 * @param	string	$name
	 * @return	object
	 */
	public function __get ($name) {
		if ('o' == $name{0}) {
			$s_func = 'NewObj' . substr($name, 1);
			if (method_exists($this, $s_func)) {
				// New object
				$this->$name = $this->$s_func();
				return $this->$name;
			}
		}

		return null;
	} // end of func __get


	/**
	 * Init func
	 * Do things according default then user config.
	 *
	 * @return	object
	 */
	public function Init () {
		return $this;
	} // end of func Init


	/**
	 * Record log msg.
	 *
	 * @param	string	$msg
	 * @param	int		$level
	 * @return	$this
	 */
	public function Log ($msg, $level = 3) {
		$ar = array(
			'level'	=> $level,
			'time'	=> date($this->sFormatTime),
			'msg'	=> $msg,
		);
		$this->aLog[] = $ar;

		// Log to errorlog ?
		if ($this->aCfg['log-errorlog'] <= $level) {
			$s_error = "Log {$ar['level']}: {$ar['msg']}\n";

			// Log backtrace
			if ($this->aCfg['log-backtrace']) {
				$ar = debug_backtrace();
				foreach ($ar as $error) {
					$s_error .= "\tLine " . $error['line']
						. ' in ' . $error['file'] . "\n";
					if (!empty($error['class']))
						$s_error .= "\t\t" . $error['class']
							. '::' . $error['function'] . "()\n";
					elseif (!empty($error['function']))
						$s_error .= "\t\t" . $error['function'] . "()\n";
				}
			}

			error_log($s_error);
		}

		return $this;
	} // end of func Log


	/**
	 * Get all log msg.
	 *
	 * @param	$level	Only output log which's level >= $level
	 * @return	string
	 */
	public function LogGet ($level = 3) {
		if (IsCli())

The function IsCli() has been deprecated with message: Use Fwlib\Util\Env::isCli()

			$s_split = "\n";
		else
			$s_split = "<br />\n";

		$s = '';
		if (!empty($this->aLog))
			foreach ($this->aLog as $log) {
				if ($level <= $log['level'])
					$s .= "[${log['time']}] ${log['msg']}"
						. $s_split;
			}

		return $s;
	} // end of func LogGet


	/**
	 * Clear all rules
	 *
	 * @param	boolean		$b_init	Re-do init.
	 */
	public function Reset ($b_init = false) {
		$this->aRule = array();
		$this->SetCfgDefault();
		if (true == $b_init)
			$this->Init();
	} // end of func Reset


	/**
	 * Set config array
	 *
	 * @see		$aCfg
	 * @param	array	$k
	 * @param	mixed	$v
	 * @return	this
	 */
	public function SetCfg ($k, $v = null) {
		if (is_array($k)) {
			// Use array $k only, ignore $v
			if (!empty($k)) {
				foreach ($k as $key => $val)
					$this->aCfg[$key] = $val;
			}
		}
		else {
			// Use array $k => $v
			$this->aCfg[$k] = $v;
		}
		return $this;
	} // end of func SetCfg


	/**
	 * Set default config.
	 *
	 * @return	object
	 */
	 protected function SetCfgDefault () {
		// Log level eq/gt this will write to php errorlog
		$this->aCfg['log-errorlog']	= 4;
		// Print backtrace in log
		$this->aCfg['log-backtrace'] = false;

		return $this;
	 } // end of func SetCfgDefault


} // end of class Fwolflib
?>