This framework is based on log4j (see {@link http://jakarta.apache.org/log4j log4j} for details).

*

Design, strategies and part of the methods documentation are developed by log4j team * (Ceki Gülcü as log4j project founder and * {@link http://jakarta.apache.org/log4j/docs/contributors.html contributors}).

* *

PHP port, extensions and modifications by VxR. All rights reserved.
* For more information, please see {@link http://www.vxr.it/log4php/}.

* *

This software is published under the terms of the LGPL License * a copy of which has been included with this distribution in the LICENSE file.

* * @package log4php * @subpackage helpers */ /** * @ignore */ if (!defined('LOG4PHP_DIR')) define('LOG4PHP_DIR', dirname(__FILE__) . '/..'); require_once(LOG4PHP_DIR . '/LoggerLevel.php'); define('LOG4PHP_OPTION_CONVERTER_DELIM_START', '${'); define('LOG4PHP_OPTION_CONVERTER_DELIM_STOP', '}'); define('LOG4PHP_OPTION_CONVERTER_DELIM_START_LEN', 2); define('LOG4PHP_OPTION_CONVERTER_DELIM_STOP_LEN', 1); /** * A convenience class to convert property values to specific types. * * @author VxR * @version $Revision: 1.1 $ * @package log4php * @subpackage helpers * @static * @since 0.5 */ class LoggerOptionConverter { /** * OptionConverter is a static class. */ function OptionConverter() { return; } /** * @param array $l * @param array $r * @return array * * @static */ function concatanateArrays($l, $r) { return array_merge($l, $r); } /** * Read a predefined var. * * It returns a value referenced by $key using this search criteria: * - if $key is a constant then return it. Else * - if $key is set in $_ENV then return it. Else * - return $def. * * @param string $key The key to search for. * @param string $def The default value to return. * @return string the string value of the system property, or the default * value if there is no property with that key. * * @static */ function getSystemProperty($key, $def) { LoggerLog::debug("LoggerOptionConverter::getSystemProperty():key=[{$key}]:def=[{$def}]."); if (defined($key)) { return (string)constant($key); } elseif (isset($_ENV[$key])) { return (string)$_ENV[$key]; } else { return $def; } } /** * If $value is true, then true is * returned. If $value is false, then * true is returned. Otherwise, $default is * returned. * *

Case of value is unimportant.

* * @param string $value * @param boolean $default * @return boolean * * @static */ function toBoolean($value, $default) { if($value === null) return $default; if ($value == 1) return true; $trimmedVal = strtolower(trim($value)); if ("true" == $trimmedVal or "yes" == $trimmedVal) return true; if ("false" == $trimmedVal) return false; return $default; } /** * @param string $value * @param integer $default * @return integer * @static */ function toInt($value, $default) { $value = trim($value); if (is_numeric($value)) { return (int)$value; } else { return $default; } } /** * Converts a standard or custom priority level to a Level * object. * *

If $value is of form "level#full_file_classname", * where full_file_classname means the class filename with path * but without php extension, then the specified class' toLevel() method * is called to process the specified level string; if no '#' * character is present, then the default {@link LoggerLevel} * class is used to process the level value.

* *

As a special case, if the $value parameter is * equal to the string "NULL", then the value null will * be returned.

* *

If any error occurs while converting the value to a level, * the $defaultValue parameter, which may be * null, is returned.

* *

Case of $value is insignificant for the level level, but is * significant for the class name part, if present.

* * @param string $value * @param LoggerLevel $defaultValue * @return LoggerLevel a {@link LoggerLevel} or null * @static */ function toLevel($value, $defaultValue) { if($value === null) return $defaultValue; $hashIndex = strpos($value, '#'); if ($hashIndex === false) { if("NULL" == strtoupper($value)) { return null; } else { // no class name specified : use standard Level class return LoggerLevel::toLevel($value, $defaultValue); } } $result = $defaultValue; $clazz = substr($value, ($hashIndex + 1)); $levelName = substr($value, 0, $hashIndex); // This is degenerate case but you never know. if("NULL" == strtoupper($levelName)) { return null; } LoggerLog::debug("LoggerOptionConverter::toLevel():class=[{$clazz}]:pri=[{$levelName}]"); if (!class_exists($clazz)) @include_once("{$clazz}.php"); $clazz = basename($clazz); if (class_exists($clazz)) { $result = @call_user_func(array($clazz, 'toLevel'), $value, $defaultValue); if (!is_a($result, 'loggerlevel')) { LoggerLog::debug("LoggerOptionConverter::toLevel():class=[{$clazz}] cannot call toLevel(). Returning default."); $result = $defaultValue; } } else { LoggerLog::warn("LoggerOptionConverter::toLevel() class '{$clazz}' doesnt exists."); } return $result; } /** * @param string $value * @param float $default * @return float * * @static */ function toFileSize($value, $default) { if ($value === null) return $default; $s = strtoupper(trim($value)); $multiplier = (float)1; if(($index = strpos($s, 'KB')) !== false) { $multiplier = 1024; $s = substr($s, 0, $index); } elseif(($index = strpos($s, 'MB')) !== false) { $multiplier = 1024 * 1024; $s = substr($s, 0, $index); } elseif(($index = strpos($s, 'GB')) !== false) { $multiplier = 1024 * 1024 * 1024; $s = substr($s, 0, $index); } if(is_numeric($s)) { return (float)$s * $multiplier; } else { LoggerLog::warn("LoggerOptionConverter::toFileSize() [{$s}] is not in proper form."); } return $default; } /** * Find the value corresponding to $key in * $props. Then perform variable substitution on the * found value. * * @param string $key * @param array $props * @return string * * @static */ function findAndSubst($key, $props) { $value = @$props[$key]; if(empty($value)) { return null; } return LoggerOptionConverter::substVars($value, $props); } /** * Perform variable substitution in string $val from the * values of keys found with the {@link getSystemProperty()} method. * *

The variable substitution delimeters are ${ and }. * *

For example, if the "MY_CONSTANT" contains "value", then * the call * * $s = LoggerOptionConverter::substituteVars("Value of key is ${MY_CONSTANT}."); * * will set the variable $s to "Value of key is value.".

* *

If no value could be found for the specified key, then the * $props parameter is searched, if the value could not * be found there, then substitution defaults to the empty string.

* *

For example, if {@link getSystemProperty()} cannot find any value for the key * "inexistentKey", then the call * * $s = LoggerOptionConverter::substVars("Value of inexistentKey is [${inexistentKey}]"); * * will set $s to "Value of inexistentKey is []".

* *

A warn is thrown if $val contains a start delimeter "${" * which is not balanced by a stop delimeter "}" and an empty string is returned.

* * @log4j-author Avy Sharell * * @param string $val The string on which variable substitution is performed. * @param array $props * @return string * * @static */ function substVars($val, $props = null) { LoggerLog::debug("LoggerOptionConverter::substVars():val=[{$val}]"); $sbuf = ''; $i = 0; while(true) { $j = strpos($val, LOG4PHP_OPTION_CONVERTER_DELIM_START, $i); if ($j === false) { LoggerLog::debug("LoggerOptionConverter::substVars() no more variables"); // no more variables if ($i == 0) { // this is a simple string LoggerLog::debug("LoggerOptionConverter::substVars() simple string"); return $val; } else { // add the tail string which contails no variables and return the result. $sbuf .= substr($val, $i); LoggerLog::debug("LoggerOptionConverter::substVars():sbuf=[{$sbuf}]. Returning sbuf"); return $sbuf; } } else { $sbuf .= substr($val, $i, $j-$i); LoggerLog::debug("LoggerOptionConverter::substVars():sbuf=[{$sbuf}]:i={$i}:j={$j}."); $k = strpos($val, LOG4PHP_OPTION_CONVERTER_DELIM_STOP, $j); if ($k === false) { LoggerLog::warn( "LoggerOptionConverter::substVars() " . "'{$val}' has no closing brace. Opening brace at position {$j}." ); return ''; } else { $j += LOG4PHP_OPTION_CONVERTER_DELIM_START_LEN; $key = substr($val, $j, $k - $j); // first try in System properties $replacement = LoggerOptionConverter::getSystemProperty($key, null); // then try props parameter if($replacement == null and $props !== null) { $replacement = @$props[$key]; } if(!empty($replacement)) { // Do variable substitution on the replacement string // such that we can solve "Hello ${x2}" as "Hello p1" // the where the properties are // x1=p1 // x2=${x1} $recursiveReplacement = LoggerOptionConverter::substVars($replacement, $props); $sbuf .= $recursiveReplacement; } $i = $k + LOG4PHP_OPTION_CONVERTER_DELIM_STOP_LEN; } } } } } ?>