| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="ApiGen 2.8.0" /> |
| <meta name="robots" content="noindex" /> |
| |
| <title>File Logger.php | Apache log4php</title> |
| |
| <script type="text/javascript" src="resources/combined.js?238209907"></script> |
| <script type="text/javascript" src="elementlist.js?4055067042"></script> |
| <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" /> |
| |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', "UA-26177991-1"]); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| </head> |
| |
| <body> |
| <div id="left"> |
| <div id="menu"> |
| <a href="index.html" title="Overview"><span>Overview</span></a> |
| |
| |
| <div id="groups"> |
| <h3>Packages</h3> |
| <ul> |
| <li class="active"><a href="package-log4php.html">log4php<span></span></a> |
| <ul> |
| <li><a href="package-log4php.appenders.html">appenders</a> |
| </li> |
| <li><a href="package-log4php.configurators.html">configurators</a> |
| </li> |
| <li><a href="package-log4php.filters.html">filters</a> |
| </li> |
| <li><a href="package-log4php.helpers.html">helpers</a> |
| </li> |
| <li><a href="package-log4php.layouts.html">layouts</a> |
| </li> |
| <li><a href="package-log4php.pattern.html">pattern</a> |
| </li> |
| <li><a href="package-log4php.renderers.html">renderers</a> |
| </li> |
| </ul></li> |
| </ul> |
| </div> |
| |
| <hr /> |
| |
| |
| <div id="elements"> |
| <h3>Classes</h3> |
| <ul> |
| <li class="active"><a href="class-Logger.html">Logger</a></li> |
| <li><a href="class-LoggerAppender.html">LoggerAppender</a></li> |
| <li><a href="class-LoggerAppenderPool.html">LoggerAppenderPool</a></li> |
| <li><a href="class-LoggerAutoloader.html">LoggerAutoloader</a></li> |
| <li><a href="class-LoggerConfigurable.html">LoggerConfigurable</a></li> |
| <li><a href="class-LoggerConfiguratorDefault.html">LoggerConfiguratorDefault</a></li> |
| <li><a href="class-LoggerFilter.html">LoggerFilter</a></li> |
| <li><a href="class-LoggerHierarchy.html">LoggerHierarchy</a></li> |
| <li><a href="class-LoggerLayout.html">LoggerLayout</a></li> |
| <li><a href="class-LoggerLevel.html">LoggerLevel</a></li> |
| <li><a href="class-LoggerLocationInfo.html">LoggerLocationInfo</a></li> |
| <li><a href="class-LoggerLoggingEvent.html">LoggerLoggingEvent</a></li> |
| <li><a href="class-LoggerMDC.html">LoggerMDC</a></li> |
| <li><a href="class-LoggerNDC.html">LoggerNDC</a></li> |
| <li><a href="class-LoggerReflectionUtils.html">LoggerReflectionUtils</a></li> |
| <li><a href="class-LoggerRoot.html">LoggerRoot</a></li> |
| <li><a href="class-LoggerThrowableInformation.html">LoggerThrowableInformation</a></li> |
| </ul> |
| |
| <h3>Interfaces</h3> |
| <ul> |
| <li><a href="class-LoggerConfigurator.html">LoggerConfigurator</a></li> |
| </ul> |
| |
| |
| <h3>Exceptions</h3> |
| <ul> |
| <li><a href="class-LoggerException.html">LoggerException</a></li> |
| </ul> |
| |
| |
| </div> |
| </div> |
| </div> |
| |
| <div id="splitter"></div> |
| |
| <div id="right"> |
| <div id="rightInner"> |
| <form id="search"> |
| <input type="hidden" name="cx" value="" /> |
| <input type="hidden" name="ie" value="UTF-8" /> |
| <input type="text" name="q" class="text" /> |
| <input type="submit" value="Search" /> |
| </form> |
| |
| <div id="navigation"> |
| <ul> |
| <li> |
| <a href="index.html" title="Overview"><span>Overview</span></a> |
| </li> |
| <li> |
| <a href="package-log4php.html" title="Summary of log4php"><span>Package</span></a> |
| </li> |
| <li> |
| <a href="class-Logger.html" title="Summary of Logger"><span>Class</span></a> |
| </li> |
| </ul> |
| <ul> |
| <li> |
| <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
| </li> |
| </ul> |
| <ul> |
| </ul> |
| </div> |
| |
| <pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span> |
| </span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/** |
| </span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Licensed to the Apache Software Foundation (ASF) under one or more |
| </span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * contributor license agreements. See the NOTICE file distributed with |
| </span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * this work for additional information regarding copyright ownership. |
| </span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * The ASF licenses this file to You under the Apache License, Version 2.0 |
| </span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * (the "License"); you may not use this file except in compliance with |
| </span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * the License. You may obtain a copy of the License at |
| </span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * |
| </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0 |
| </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * |
| </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software |
| </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS, |
| </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * See the License for the specific language governing permissions and |
| </span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * limitations under the License. |
| </span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * |
| </span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @package log4php |
| </span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> */</span> |
| </span><span id="20" class="l"><a class="l" href="#20"> 20: </a> |
| </span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">require</span> <span class="php-keyword2">dirname</span>(__FILE__) . <span class="php-quote">'/LoggerAutoloader.php'</span>; |
| </span><span id="22" class="l"><a class="l" href="#22"> 22: </a> |
| </span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment">/** |
| </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * This is the central class in the log4php package. All logging operations |
| </span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * are done through this class. |
| </span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * |
| </span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The main logging methods are: |
| </span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * <ul> |
| </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * <li>{@link trace()}</li> |
| </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * <li>{@link debug()}</li> |
| </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * <li>{@link info()}</li> |
| </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * <li>{@link warn()}</li> |
| </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * <li>{@link error()}</li> |
| </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * <li>{@link fatal()}</li> |
| </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * </ul> |
| </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * |
| </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * @package log4php |
| </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @version SVN: $Id: Logger.php 1395241 2012-10-07 08:28:53Z ihabunek $ |
| </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @link http://logging.apache.org/log4php |
| </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> */</span> |
| </span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-keyword1">class</span> <a id="Logger" href="#Logger">Logger</a> { |
| </span><span id="43" class="l"><a class="l" href="#43"> 43: </a> |
| </span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">/** |
| </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * Logger additivity. If set to true then child loggers will inherit |
| </span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * the appenders of their ancestors by default. |
| </span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * @var boolean |
| </span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span> |
| </span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$additive" href="#$additive">$additive</a></span> = <span class="php-keyword1">true</span>; |
| </span><span id="50" class="l"><a class="l" href="#50"> 50: </a> |
| </span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-comment">/** |
| </span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The Logger's fully qualified class name. |
| </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * TODO: Determine if this is useful. |
| </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> */</span> |
| </span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$fqcn" href="#$fqcn">$fqcn</a></span> = <span class="php-quote">'Logger'</span>; |
| </span><span id="56" class="l"><a class="l" href="#56"> 56: </a> |
| </span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-comment">/** The assigned Logger level. */</span> |
| </span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$level" href="#$level">$level</a></span>; |
| </span><span id="59" class="l"><a class="l" href="#59"> 59: </a> |
| </span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-comment">/** The name of this Logger instance. */</span> |
| </span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$name" href="#$name">$name</a></span>; |
| </span><span id="62" class="l"><a class="l" href="#62"> 62: </a> |
| </span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-comment">/** The parent logger. Set to null if this is the root logger. */</span> |
| </span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$parent" href="#$parent">$parent</a></span>; |
| </span><span id="65" class="l"><a class="l" href="#65"> 65: </a> |
| </span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-comment">/** A collection of appenders linked to this logger. */</span> |
| </span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$appenders" href="#$appenders">$appenders</a></span> = <span class="php-keyword1">array</span>(); |
| </span><span id="68" class="l"><a class="l" href="#68"> 68: </a> |
| </span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-comment">/** |
| </span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * Constructor. |
| </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * @param string $name Name of the logger. |
| </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> */</span> |
| </span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$name</span>) { |
| </span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-var">$this</span>->name = <span class="php-var">$name</span>; |
| </span><span id="75" class="l"><a class="l" href="#75"> 75: </a> } |
| </span><span id="76" class="l"><a class="l" href="#76"> 76: </a> |
| </span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-comment">/** |
| </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * Returns the logger name. |
| </span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * @return string |
| </span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> */</span> |
| </span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getName" href="#_getName">getName</a>() { |
| </span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->name; |
| </span><span id="83" class="l"><a class="l" href="#83"> 83: </a> } |
| </span><span id="84" class="l"><a class="l" href="#84"> 84: </a> |
| </span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-comment">/** |
| </span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * Returns the parent Logger. Can be null if this is the root logger. |
| </span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @return Logger |
| </span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span> |
| </span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getParent" href="#_getParent">getParent</a>() { |
| </span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->parent; |
| </span><span id="91" class="l"><a class="l" href="#91"> 91: </a> } |
| </span><span id="92" class="l"><a class="l" href="#92"> 92: </a> |
| </span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-comment">// *** Logging methods ***</span> |
| </span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="96" class="l"><a class="l" href="#96"> 96: </a> |
| </span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-comment">/** |
| </span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * Log a message object with the TRACE level. |
| </span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * |
| </span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span> |
| </span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_trace" href="#_trace">trace</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelTrace(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="106" class="l"><a class="l" href="#106">106: </a> } |
| </span><span id="107" class="l"><a class="l" href="#107">107: </a> |
| </span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-comment">/** |
| </span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * Log a message object with the DEBUG level. |
| </span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * |
| </span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> */</span> |
| </span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_debug" href="#_debug">debug</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelDebug(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="117" class="l"><a class="l" href="#117">117: </a> } |
| </span><span id="118" class="l"><a class="l" href="#118">118: </a> |
| </span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-comment">/** |
| </span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * Log a message object with the INFO Level. |
| </span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * |
| </span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> */</span> |
| </span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelInfo(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="128" class="l"><a class="l" href="#128">128: </a> } |
| </span><span id="129" class="l"><a class="l" href="#129">129: </a> |
| </span><span id="130" class="l"><a class="l" href="#130">130: </a> <span class="php-comment">/** |
| </span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * Log a message with the WARN level. |
| </span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * |
| </span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> */</span> |
| </span><span id="137" class="l"><a class="l" href="#137">137: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_warn" href="#_warn">warn</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="138" class="l"><a class="l" href="#138">138: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelWarn(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="139" class="l"><a class="l" href="#139">139: </a> } |
| </span><span id="140" class="l"><a class="l" href="#140">140: </a> |
| </span><span id="141" class="l"><a class="l" href="#141">141: </a> <span class="php-comment">/** |
| </span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Log a message object with the ERROR level. |
| </span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * |
| </span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> */</span> |
| </span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_error" href="#_error">error</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelError(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="150" class="l"><a class="l" href="#150">150: </a> } |
| </span><span id="151" class="l"><a class="l" href="#151">151: </a> |
| </span><span id="152" class="l"><a class="l" href="#152">152: </a> <span class="php-comment">/** |
| </span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * Log a message object with the FATAL level. |
| </span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * |
| </span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * @param mixed $message message |
| </span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> */</span> |
| </span><span id="159" class="l"><a class="l" href="#159">159: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_fatal" href="#_fatal">fatal</a>(<span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="160" class="l"><a class="l" href="#160">160: </a> <span class="php-var">$this</span>-><span class="php-keyword2">log</span>(LoggerLevel::getLevelFatal(), <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="161" class="l"><a class="l" href="#161">161: </a> } |
| </span><span id="162" class="l"><a class="l" href="#162">162: </a> |
| </span><span id="163" class="l"><a class="l" href="#163">163: </a> <span class="php-comment">/** |
| </span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * Log a message using the provided logging level. |
| </span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * |
| </span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * @param LoggerLevel $level The logging level. |
| </span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * @param mixed $message Message to log. |
| </span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> */</span> |
| </span><span id="171" class="l"><a class="l" href="#171">171: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">log</span>(LoggerLevel <span class="php-var">$level</span>, <span class="php-var">$message</span>, <span class="php-var">$throwable</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="172" class="l"><a class="l" href="#172">172: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>->isEnabledFor(<span class="php-var">$level</span>)) { |
| </span><span id="173" class="l"><a class="l" href="#173">173: </a> <span class="php-var">$event</span> = <span class="php-keyword1">new</span> LoggerLoggingEvent(<span class="php-var">$this</span>->fqcn, <span class="php-var">$this</span>, <span class="php-var">$level</span>, <span class="php-var">$message</span>, <span class="php-keyword1">null</span>, <span class="php-var">$throwable</span>); |
| </span><span id="174" class="l"><a class="l" href="#174">174: </a> <span class="php-var">$this</span>->callAppenders(<span class="php-var">$event</span>); |
| </span><span id="175" class="l"><a class="l" href="#175">175: </a> } |
| </span><span id="176" class="l"><a class="l" href="#176">176: </a> |
| </span><span id="177" class="l"><a class="l" href="#177">177: </a> <span class="php-comment">// Forward the event upstream if additivity is turned on</span> |
| </span><span id="178" class="l"><a class="l" href="#178">178: </a> <span class="php-keyword1">if</span>(<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->parent) && <span class="php-var">$this</span>->getAdditivity()) { |
| </span><span id="179" class="l"><a class="l" href="#179">179: </a> |
| </span><span id="180" class="l"><a class="l" href="#180">180: </a> <span class="php-comment">// Use the event if already created</span> |
| </span><span id="181" class="l"><a class="l" href="#181">181: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$event</span>)) { |
| </span><span id="182" class="l"><a class="l" href="#182">182: </a> <span class="php-var">$this</span>->parent->logEvent(<span class="php-var">$event</span>); |
| </span><span id="183" class="l"><a class="l" href="#183">183: </a> } <span class="php-keyword1">else</span> { |
| </span><span id="184" class="l"><a class="l" href="#184">184: </a> <span class="php-var">$this</span>->parent-><span class="php-keyword2">log</span>(<span class="php-var">$level</span>, <span class="php-var">$message</span>, <span class="php-var">$throwable</span>); |
| </span><span id="185" class="l"><a class="l" href="#185">185: </a> } |
| </span><span id="186" class="l"><a class="l" href="#186">186: </a> } |
| </span><span id="187" class="l"><a class="l" href="#187">187: </a> } |
| </span><span id="188" class="l"><a class="l" href="#188">188: </a> |
| </span><span id="189" class="l"><a class="l" href="#189">189: </a> <span class="php-comment">/** |
| </span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> * Logs an already prepared logging event object. |
| </span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * @param LoggerLoggingEvent $event |
| </span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> */</span> |
| </span><span id="193" class="l"><a class="l" href="#193">193: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_logEvent" href="#_logEvent">logEvent</a>(LoggerLoggingEvent <span class="php-var">$event</span>) { |
| </span><span id="194" class="l"><a class="l" href="#194">194: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>->isEnabledFor(<span class="php-var">$event</span>->getLevel())) { |
| </span><span id="195" class="l"><a class="l" href="#195">195: </a> <span class="php-var">$this</span>->callAppenders(<span class="php-var">$event</span>); |
| </span><span id="196" class="l"><a class="l" href="#196">196: </a> } |
| </span><span id="197" class="l"><a class="l" href="#197">197: </a> |
| </span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-comment">// Forward the event upstream if additivity is turned on</span> |
| </span><span id="199" class="l"><a class="l" href="#199">199: </a> <span class="php-keyword1">if</span>(<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->parent) && <span class="php-var">$this</span>->getAdditivity()) { |
| </span><span id="200" class="l"><a class="l" href="#200">200: </a> <span class="php-var">$this</span>->parent->logEvent(<span class="php-var">$event</span>); |
| </span><span id="201" class="l"><a class="l" href="#201">201: </a> } |
| </span><span id="202" class="l"><a class="l" href="#202">202: </a> } |
| </span><span id="203" class="l"><a class="l" href="#203">203: </a> |
| </span><span id="204" class="l"><a class="l" href="#204">204: </a> <span class="php-comment">/** |
| </span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment"> * If assertion parameter evaluates as false, then logs the message |
| </span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> * using the ERROR level. |
| </span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * |
| </span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> * @param bool $assertion |
| </span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> * @param string $msg message to log |
| </span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> */</span> |
| </span><span id="211" class="l"><a class="l" href="#211">211: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_assertLog" href="#_assertLog">assertLog</a>(<span class="php-var">$assertion</span> = <span class="php-keyword1">true</span>, <span class="php-var">$msg</span> = <span class="php-quote">''</span>) { |
| </span><span id="212" class="l"><a class="l" href="#212">212: </a> <span class="php-keyword1">if</span>(<span class="php-var">$assertion</span> == <span class="php-keyword1">false</span>) { |
| </span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-var">$this</span>->error(<span class="php-var">$msg</span>); |
| </span><span id="214" class="l"><a class="l" href="#214">214: </a> } |
| </span><span id="215" class="l"><a class="l" href="#215">215: </a> } |
| </span><span id="216" class="l"><a class="l" href="#216">216: </a> |
| </span><span id="217" class="l"><a class="l" href="#217">217: </a> <span class="php-comment">/** |
| </span></span><span id="218" class="l"><a class="l" href="#218">218: </a><span class="php-comment"> * This method creates a new logging event and logs the event without |
| </span></span><span id="219" class="l"><a class="l" href="#219">219: </a><span class="php-comment"> * further checks. |
| </span></span><span id="220" class="l"><a class="l" href="#220">220: </a><span class="php-comment"> * |
| </span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment"> * It should not be called directly. Use {@link trace()}, {@link debug()}, |
| </span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment"> * {@link info()}, {@link warn()}, {@link error()} and {@link fatal()} |
| </span></span><span id="223" class="l"><a class="l" href="#223">223: </a><span class="php-comment"> * wrappers. |
| </span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment"> * |
| </span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> * @param string $fqcn Fully qualified class name of the Logger |
| </span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> * @param Exception $throwable Optional throwable information to include |
| </span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> * in the logging event. |
| </span></span><span id="228" class="l"><a class="l" href="#228">228: </a><span class="php-comment"> * @param LoggerLevel $level log level |
| </span></span><span id="229" class="l"><a class="l" href="#229">229: </a><span class="php-comment"> * @param mixed $message message to log |
| </span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment"> */</span> |
| </span><span id="231" class="l"><a class="l" href="#231">231: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_forcedLog" href="#_forcedLog">forcedLog</a>(<span class="php-var">$fqcn</span>, <span class="php-var">$throwable</span>, LoggerLevel <span class="php-var">$level</span>, <span class="php-var">$message</span>) { |
| </span><span id="232" class="l"><a class="l" href="#232">232: </a> <span class="php-var">$event</span> = <span class="php-keyword1">new</span> LoggerLoggingEvent(<span class="php-var">$fqcn</span>, <span class="php-var">$this</span>, <span class="php-var">$level</span>, <span class="php-var">$message</span>, <span class="php-keyword1">null</span>, <span class="php-var">$throwable</span>); |
| </span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-var">$this</span>->callAppenders(<span class="php-var">$event</span>); |
| </span><span id="234" class="l"><a class="l" href="#234">234: </a> |
| </span><span id="235" class="l"><a class="l" href="#235">235: </a> <span class="php-comment">// Forward the event upstream if additivity is turned on</span> |
| </span><span id="236" class="l"><a class="l" href="#236">236: </a> <span class="php-keyword1">if</span>(<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->parent) && <span class="php-var">$this</span>->getAdditivity()) { |
| </span><span id="237" class="l"><a class="l" href="#237">237: </a> <span class="php-var">$this</span>->parent->logEvent(<span class="php-var">$event</span>); |
| </span><span id="238" class="l"><a class="l" href="#238">238: </a> } |
| </span><span id="239" class="l"><a class="l" href="#239">239: </a> } |
| </span><span id="240" class="l"><a class="l" href="#240">240: </a> |
| </span><span id="241" class="l"><a class="l" href="#241">241: </a> <span class="php-comment">/** |
| </span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment"> * Forwards the given logging event to all linked appenders. |
| </span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment"> * @param LoggerLoggingEvent $event |
| </span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment"> */</span> |
| </span><span id="245" class="l"><a class="l" href="#245">245: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_callAppenders" href="#_callAppenders">callAppenders</a>(<span class="php-var">$event</span>) { |
| </span><span id="246" class="l"><a class="l" href="#246">246: </a> <span class="php-keyword1">foreach</span>(<span class="php-var">$this</span>->appenders <span class="php-keyword1">as</span> <span class="php-var">$appender</span>) { |
| </span><span id="247" class="l"><a class="l" href="#247">247: </a> <span class="php-var">$appender</span>->doAppend(<span class="php-var">$event</span>); |
| </span><span id="248" class="l"><a class="l" href="#248">248: </a> } |
| </span><span id="249" class="l"><a class="l" href="#249">249: </a> } |
| </span><span id="250" class="l"><a class="l" href="#250">250: </a> |
| </span><span id="251" class="l"><a class="l" href="#251">251: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="252" class="l"><a class="l" href="#252">252: </a> <span class="php-comment">// *** Checker methods ***</span> |
| </span><span id="253" class="l"><a class="l" href="#253">253: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="254" class="l"><a class="l" href="#254">254: </a> |
| </span><span id="255" class="l"><a class="l" href="#255">255: </a> <span class="php-comment">/** |
| </span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> * Check whether this Logger is enabled for a given Level passed as parameter. |
| </span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment"> * |
| </span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment"> * @param LoggerLevel level |
| </span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment"> */</span> |
| </span><span id="261" class="l"><a class="l" href="#261">261: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isEnabledFor" href="#_isEnabledFor">isEnabledFor</a>(LoggerLevel <span class="php-var">$level</span>) { |
| </span><span id="262" class="l"><a class="l" href="#262">262: </a> <span class="php-keyword1">return</span> <span class="php-var">$level</span>->isGreaterOrEqual(<span class="php-var">$this</span>->getEffectiveLevel()); |
| </span><span id="263" class="l"><a class="l" href="#263">263: </a> } |
| </span><span id="264" class="l"><a class="l" href="#264">264: </a> |
| </span><span id="265" class="l"><a class="l" href="#265">265: </a> <span class="php-comment">/** |
| </span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment"> * Check whether this Logger is enabled for the TRACE Level. |
| </span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment"> */</span> |
| </span><span id="269" class="l"><a class="l" href="#269">269: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isTraceEnabled" href="#_isTraceEnabled">isTraceEnabled</a>() { |
| </span><span id="270" class="l"><a class="l" href="#270">270: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelTrace()); |
| </span><span id="271" class="l"><a class="l" href="#271">271: </a> } |
| </span><span id="272" class="l"><a class="l" href="#272">272: </a> |
| </span><span id="273" class="l"><a class="l" href="#273">273: </a> <span class="php-comment">/** |
| </span></span><span id="274" class="l"><a class="l" href="#274">274: </a><span class="php-comment"> * Check whether this Logger is enabled for the DEBUG Level. |
| </span></span><span id="275" class="l"><a class="l" href="#275">275: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="276" class="l"><a class="l" href="#276">276: </a><span class="php-comment"> */</span> |
| </span><span id="277" class="l"><a class="l" href="#277">277: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isDebugEnabled" href="#_isDebugEnabled">isDebugEnabled</a>() { |
| </span><span id="278" class="l"><a class="l" href="#278">278: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelDebug()); |
| </span><span id="279" class="l"><a class="l" href="#279">279: </a> } |
| </span><span id="280" class="l"><a class="l" href="#280">280: </a> |
| </span><span id="281" class="l"><a class="l" href="#281">281: </a> <span class="php-comment">/** |
| </span></span><span id="282" class="l"><a class="l" href="#282">282: </a><span class="php-comment"> * Check whether this Logger is enabled for the INFO Level. |
| </span></span><span id="283" class="l"><a class="l" href="#283">283: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="284" class="l"><a class="l" href="#284">284: </a><span class="php-comment"> */</span> |
| </span><span id="285" class="l"><a class="l" href="#285">285: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isInfoEnabled" href="#_isInfoEnabled">isInfoEnabled</a>() { |
| </span><span id="286" class="l"><a class="l" href="#286">286: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelInfo()); |
| </span><span id="287" class="l"><a class="l" href="#287">287: </a> } |
| </span><span id="288" class="l"><a class="l" href="#288">288: </a> |
| </span><span id="289" class="l"><a class="l" href="#289">289: </a> <span class="php-comment">/** |
| </span></span><span id="290" class="l"><a class="l" href="#290">290: </a><span class="php-comment"> * Check whether this Logger is enabled for the WARN Level. |
| </span></span><span id="291" class="l"><a class="l" href="#291">291: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="292" class="l"><a class="l" href="#292">292: </a><span class="php-comment"> */</span> |
| </span><span id="293" class="l"><a class="l" href="#293">293: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isWarnEnabled" href="#_isWarnEnabled">isWarnEnabled</a>() { |
| </span><span id="294" class="l"><a class="l" href="#294">294: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelWarn()); |
| </span><span id="295" class="l"><a class="l" href="#295">295: </a> } |
| </span><span id="296" class="l"><a class="l" href="#296">296: </a> |
| </span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-comment">/** |
| </span></span><span id="298" class="l"><a class="l" href="#298">298: </a><span class="php-comment"> * Check whether this Logger is enabled for the ERROR Level. |
| </span></span><span id="299" class="l"><a class="l" href="#299">299: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="300" class="l"><a class="l" href="#300">300: </a><span class="php-comment"> */</span> |
| </span><span id="301" class="l"><a class="l" href="#301">301: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isErrorEnabled" href="#_isErrorEnabled">isErrorEnabled</a>() { |
| </span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelError()); |
| </span><span id="303" class="l"><a class="l" href="#303">303: </a> } |
| </span><span id="304" class="l"><a class="l" href="#304">304: </a> |
| </span><span id="305" class="l"><a class="l" href="#305">305: </a> <span class="php-comment">/** |
| </span></span><span id="306" class="l"><a class="l" href="#306">306: </a><span class="php-comment"> * Check whether this Logger is enabled for the FATAL Level. |
| </span></span><span id="307" class="l"><a class="l" href="#307">307: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="308" class="l"><a class="l" href="#308">308: </a><span class="php-comment"> */</span> |
| </span><span id="309" class="l"><a class="l" href="#309">309: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isFatalEnabled" href="#_isFatalEnabled">isFatalEnabled</a>() { |
| </span><span id="310" class="l"><a class="l" href="#310">310: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->isEnabledFor(LoggerLevel::getLevelFatal()); |
| </span><span id="311" class="l"><a class="l" href="#311">311: </a> } |
| </span><span id="312" class="l"><a class="l" href="#312">312: </a> |
| </span><span id="313" class="l"><a class="l" href="#313">313: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="314" class="l"><a class="l" href="#314">314: </a> <span class="php-comment">// *** Configuration methods ***</span> |
| </span><span id="315" class="l"><a class="l" href="#315">315: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="316" class="l"><a class="l" href="#316">316: </a> |
| </span><span id="317" class="l"><a class="l" href="#317">317: </a> <span class="php-comment">/** |
| </span></span><span id="318" class="l"><a class="l" href="#318">318: </a><span class="php-comment"> * Adds a new appender to the Logger. |
| </span></span><span id="319" class="l"><a class="l" href="#319">319: </a><span class="php-comment"> * @param LoggerAppender $appender The appender to add. |
| </span></span><span id="320" class="l"><a class="l" href="#320">320: </a><span class="php-comment"> */</span> |
| </span><span id="321" class="l"><a class="l" href="#321">321: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addAppender" href="#_addAppender">addAppender</a>(<span class="php-var">$appender</span>) { |
| </span><span id="322" class="l"><a class="l" href="#322">322: </a> <span class="php-var">$appenderName</span> = <span class="php-var">$appender</span>->getName(); |
| </span><span id="323" class="l"><a class="l" href="#323">323: </a> <span class="php-var">$this</span>->appenders[<span class="php-var">$appenderName</span>] = <span class="php-var">$appender</span>; |
| </span><span id="324" class="l"><a class="l" href="#324">324: </a> } |
| </span><span id="325" class="l"><a class="l" href="#325">325: </a> |
| </span><span id="326" class="l"><a class="l" href="#326">326: </a> <span class="php-comment">/** Removes all appenders from the Logger. */</span> |
| </span><span id="327" class="l"><a class="l" href="#327">327: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_removeAllAppenders" href="#_removeAllAppenders">removeAllAppenders</a>() { |
| </span><span id="328" class="l"><a class="l" href="#328">328: </a> <span class="php-keyword1">foreach</span>(<span class="php-var">$this</span>->appenders <span class="php-keyword1">as</span> <span class="php-var">$name</span> => <span class="php-var">$appender</span>) { |
| </span><span id="329" class="l"><a class="l" href="#329">329: </a> <span class="php-var">$this</span>->removeAppender(<span class="php-var">$name</span>); |
| </span><span id="330" class="l"><a class="l" href="#330">330: </a> } |
| </span><span id="331" class="l"><a class="l" href="#331">331: </a> } |
| </span><span id="332" class="l"><a class="l" href="#332">332: </a> |
| </span><span id="333" class="l"><a class="l" href="#333">333: </a> <span class="php-comment">/** |
| </span></span><span id="334" class="l"><a class="l" href="#334">334: </a><span class="php-comment"> * Remove the appender passed as parameter form the Logger. |
| </span></span><span id="335" class="l"><a class="l" href="#335">335: </a><span class="php-comment"> * @param mixed $appender an appender name or a {@link LoggerAppender} instance. |
| </span></span><span id="336" class="l"><a class="l" href="#336">336: </a><span class="php-comment"> */</span> |
| </span><span id="337" class="l"><a class="l" href="#337">337: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_removeAppender" href="#_removeAppender">removeAppender</a>(<span class="php-var">$appender</span>) { |
| </span><span id="338" class="l"><a class="l" href="#338">338: </a> <span class="php-keyword1">if</span>(<span class="php-var">$appender</span> <span class="php-keyword1">instanceof</span> LoggerAppender) { |
| </span><span id="339" class="l"><a class="l" href="#339">339: </a> <span class="php-var">$appender</span>->close(); |
| </span><span id="340" class="l"><a class="l" href="#340">340: </a> <span class="php-keyword1">unset</span>(<span class="php-var">$this</span>->appenders[<span class="php-var">$appender</span>->getName()]); |
| </span><span id="341" class="l"><a class="l" href="#341">341: </a> } <span class="php-keyword1">else</span> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_string</span>(<span class="php-var">$appender</span>) <span class="php-keyword1">and</span> <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->appenders[<span class="php-var">$appender</span>])) { |
| </span><span id="342" class="l"><a class="l" href="#342">342: </a> <span class="php-var">$this</span>->appenders[<span class="php-var">$appender</span>]->close(); |
| </span><span id="343" class="l"><a class="l" href="#343">343: </a> <span class="php-keyword1">unset</span>(<span class="php-var">$this</span>->appenders[<span class="php-var">$appender</span>]); |
| </span><span id="344" class="l"><a class="l" href="#344">344: </a> } |
| </span><span id="345" class="l"><a class="l" href="#345">345: </a> } |
| </span><span id="346" class="l"><a class="l" href="#346">346: </a> |
| </span><span id="347" class="l"><a class="l" href="#347">347: </a> <span class="php-comment">/** |
| </span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> * Returns the appenders linked to this logger as an array. |
| </span></span><span id="349" class="l"><a class="l" href="#349">349: </a><span class="php-comment"> * @return array collection of appender names |
| </span></span><span id="350" class="l"><a class="l" href="#350">350: </a><span class="php-comment"> */</span> |
| </span><span id="351" class="l"><a class="l" href="#351">351: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getAllAppenders" href="#_getAllAppenders">getAllAppenders</a>() { |
| </span><span id="352" class="l"><a class="l" href="#352">352: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->appenders; |
| </span><span id="353" class="l"><a class="l" href="#353">353: </a> } |
| </span><span id="354" class="l"><a class="l" href="#354">354: </a> |
| </span><span id="355" class="l"><a class="l" href="#355">355: </a> <span class="php-comment">/** |
| </span></span><span id="356" class="l"><a class="l" href="#356">356: </a><span class="php-comment"> * Returns a linked appender by name. |
| </span></span><span id="357" class="l"><a class="l" href="#357">357: </a><span class="php-comment"> * @return LoggerAppender |
| </span></span><span id="358" class="l"><a class="l" href="#358">358: </a><span class="php-comment"> */</span> |
| </span><span id="359" class="l"><a class="l" href="#359">359: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getAppender" href="#_getAppender">getAppender</a>(<span class="php-var">$name</span>) { |
| </span><span id="360" class="l"><a class="l" href="#360">360: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->appenders[<span class="php-var">$name</span>]; |
| </span><span id="361" class="l"><a class="l" href="#361">361: </a> } |
| </span><span id="362" class="l"><a class="l" href="#362">362: </a> |
| </span><span id="363" class="l"><a class="l" href="#363">363: </a> <span class="php-comment">/** |
| </span></span><span id="364" class="l"><a class="l" href="#364">364: </a><span class="php-comment"> * Sets the additivity flag. |
| </span></span><span id="365" class="l"><a class="l" href="#365">365: </a><span class="php-comment"> * @param boolean $additive |
| </span></span><span id="366" class="l"><a class="l" href="#366">366: </a><span class="php-comment"> */</span> |
| </span><span id="367" class="l"><a class="l" href="#367">367: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setAdditivity" href="#_setAdditivity">setAdditivity</a>(<span class="php-var">$additive</span>) { |
| </span><span id="368" class="l"><a class="l" href="#368">368: </a> <span class="php-var">$this</span>->additive = (bool)<span class="php-var">$additive</span>; |
| </span><span id="369" class="l"><a class="l" href="#369">369: </a> } |
| </span><span id="370" class="l"><a class="l" href="#370">370: </a> |
| </span><span id="371" class="l"><a class="l" href="#371">371: </a> <span class="php-comment">/** |
| </span></span><span id="372" class="l"><a class="l" href="#372">372: </a><span class="php-comment"> * Returns the additivity flag. |
| </span></span><span id="373" class="l"><a class="l" href="#373">373: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="374" class="l"><a class="l" href="#374">374: </a><span class="php-comment"> */</span> |
| </span><span id="375" class="l"><a class="l" href="#375">375: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getAdditivity" href="#_getAdditivity">getAdditivity</a>() { |
| </span><span id="376" class="l"><a class="l" href="#376">376: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->additive; |
| </span><span id="377" class="l"><a class="l" href="#377">377: </a> } |
| </span><span id="378" class="l"><a class="l" href="#378">378: </a> |
| </span><span id="379" class="l"><a class="l" href="#379">379: </a> <span class="php-comment">/** |
| </span></span><span id="380" class="l"><a class="l" href="#380">380: </a><span class="php-comment"> * Starting from this Logger, search the Logger hierarchy for a non-null level and return it. |
| </span></span><span id="381" class="l"><a class="l" href="#381">381: </a><span class="php-comment"> * @see LoggerLevel |
| </span></span><span id="382" class="l"><a class="l" href="#382">382: </a><span class="php-comment"> * @return LoggerLevel or null |
| </span></span><span id="383" class="l"><a class="l" href="#383">383: </a><span class="php-comment"> */</span> |
| </span><span id="384" class="l"><a class="l" href="#384">384: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEffectiveLevel" href="#_getEffectiveLevel">getEffectiveLevel</a>() { |
| </span><span id="385" class="l"><a class="l" href="#385">385: </a> <span class="php-keyword1">for</span>(<span class="php-var">$logger</span> = <span class="php-var">$this</span>; <span class="php-var">$logger</span> !== <span class="php-keyword1">null</span>; <span class="php-var">$logger</span> = <span class="php-var">$logger</span>->getParent()) { |
| </span><span id="386" class="l"><a class="l" href="#386">386: </a> <span class="php-keyword1">if</span>(<span class="php-var">$logger</span>->getLevel() !== <span class="php-keyword1">null</span>) { |
| </span><span id="387" class="l"><a class="l" href="#387">387: </a> <span class="php-keyword1">return</span> <span class="php-var">$logger</span>->getLevel(); |
| </span><span id="388" class="l"><a class="l" href="#388">388: </a> } |
| </span><span id="389" class="l"><a class="l" href="#389">389: </a> } |
| </span><span id="390" class="l"><a class="l" href="#390">390: </a> } |
| </span><span id="391" class="l"><a class="l" href="#391">391: </a> |
| </span><span id="392" class="l"><a class="l" href="#392">392: </a> <span class="php-comment">/** |
| </span></span><span id="393" class="l"><a class="l" href="#393">393: </a><span class="php-comment"> * Get the assigned Logger level. |
| </span></span><span id="394" class="l"><a class="l" href="#394">394: </a><span class="php-comment"> * @return LoggerLevel The assigned level or null if none is assigned. |
| </span></span><span id="395" class="l"><a class="l" href="#395">395: </a><span class="php-comment"> */</span> |
| </span><span id="396" class="l"><a class="l" href="#396">396: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getLevel" href="#_getLevel">getLevel</a>() { |
| </span><span id="397" class="l"><a class="l" href="#397">397: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->level; |
| </span><span id="398" class="l"><a class="l" href="#398">398: </a> } |
| </span><span id="399" class="l"><a class="l" href="#399">399: </a> |
| </span><span id="400" class="l"><a class="l" href="#400">400: </a> <span class="php-comment">/** |
| </span></span><span id="401" class="l"><a class="l" href="#401">401: </a><span class="php-comment"> * Set the Logger level. |
| </span></span><span id="402" class="l"><a class="l" href="#402">402: </a><span class="php-comment"> * |
| </span></span><span id="403" class="l"><a class="l" href="#403">403: </a><span class="php-comment"> * Use LoggerLevel::getLevelXXX() methods to get a LoggerLevel object, e.g. |
| </span></span><span id="404" class="l"><a class="l" href="#404">404: </a><span class="php-comment"> * <code>$logger->setLevel(LoggerLevel::getLevelInfo());</code> |
| </span></span><span id="405" class="l"><a class="l" href="#405">405: </a><span class="php-comment"> * |
| </span></span><span id="406" class="l"><a class="l" href="#406">406: </a><span class="php-comment"> * @param LoggerLevel $level The level to set, or NULL to clear the logger level. |
| </span></span><span id="407" class="l"><a class="l" href="#407">407: </a><span class="php-comment"> */</span> |
| </span><span id="408" class="l"><a class="l" href="#408">408: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setLevel" href="#_setLevel">setLevel</a>(LoggerLevel <span class="php-var">$level</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="409" class="l"><a class="l" href="#409">409: </a> <span class="php-var">$this</span>->level = <span class="php-var">$level</span>; |
| </span><span id="410" class="l"><a class="l" href="#410">410: </a> } |
| </span><span id="411" class="l"><a class="l" href="#411">411: </a> |
| </span><span id="412" class="l"><a class="l" href="#412">412: </a> <span class="php-comment">/** |
| </span></span><span id="413" class="l"><a class="l" href="#413">413: </a><span class="php-comment"> * Checks whether an appender is attached to this logger instance. |
| </span></span><span id="414" class="l"><a class="l" href="#414">414: </a><span class="php-comment"> * |
| </span></span><span id="415" class="l"><a class="l" href="#415">415: </a><span class="php-comment"> * @param LoggerAppender $appender |
| </span></span><span id="416" class="l"><a class="l" href="#416">416: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="417" class="l"><a class="l" href="#417">417: </a><span class="php-comment"> */</span> |
| </span><span id="418" class="l"><a class="l" href="#418">418: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isAttached" href="#_isAttached">isAttached</a>(LoggerAppender <span class="php-var">$appender</span>) { |
| </span><span id="419" class="l"><a class="l" href="#419">419: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->appenders[<span class="php-var">$appender</span>->getName()]); |
| </span><span id="420" class="l"><a class="l" href="#420">420: </a> } |
| </span><span id="421" class="l"><a class="l" href="#421">421: </a> |
| </span><span id="422" class="l"><a class="l" href="#422">422: </a> <span class="php-comment">/** |
| </span></span><span id="423" class="l"><a class="l" href="#423">423: </a><span class="php-comment"> * Sets the parent logger. |
| </span></span><span id="424" class="l"><a class="l" href="#424">424: </a><span class="php-comment"> * @param Logger $logger |
| </span></span><span id="425" class="l"><a class="l" href="#425">425: </a><span class="php-comment"> */</span> |
| </span><span id="426" class="l"><a class="l" href="#426">426: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setParent" href="#_setParent">setParent</a>(Logger <span class="php-var">$logger</span>) { |
| </span><span id="427" class="l"><a class="l" href="#427">427: </a> <span class="php-var">$this</span>->parent = <span class="php-var">$logger</span>; |
| </span><span id="428" class="l"><a class="l" href="#428">428: </a> } |
| </span><span id="429" class="l"><a class="l" href="#429">429: </a> |
| </span><span id="430" class="l"><a class="l" href="#430">430: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="431" class="l"><a class="l" href="#431">431: </a> <span class="php-comment">// *** Static methods and properties ***</span> |
| </span><span id="432" class="l"><a class="l" href="#432">432: </a> <span class="php-comment">// ******************************************</span> |
| </span><span id="433" class="l"><a class="l" href="#433">433: </a> |
| </span><span id="434" class="l"><a class="l" href="#434">434: </a> <span class="php-comment">/** The logger hierarchy used by log4php. */</span> |
| </span><span id="435" class="l"><a class="l" href="#435">435: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$hierarchy" href="#$hierarchy">$hierarchy</a></span>; |
| </span><span id="436" class="l"><a class="l" href="#436">436: </a> |
| </span><span id="437" class="l"><a class="l" href="#437">437: </a> <span class="php-comment">/** Inidicates if log4php has been initialized */</span> |
| </span><span id="438" class="l"><a class="l" href="#438">438: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$initialized" href="#$initialized">$initialized</a></span> = <span class="php-keyword1">false</span>; |
| </span><span id="439" class="l"><a class="l" href="#439">439: </a> |
| </span><span id="440" class="l"><a class="l" href="#440">440: </a> <span class="php-comment">/** |
| </span></span><span id="441" class="l"><a class="l" href="#441">441: </a><span class="php-comment"> * Returns the hierarchy used by this Logger. |
| </span></span><span id="442" class="l"><a class="l" href="#442">442: </a><span class="php-comment"> * |
| </span></span><span id="443" class="l"><a class="l" href="#443">443: </a><span class="php-comment"> * Caution: do not use this hierarchy unless you have called initialize(). |
| </span></span><span id="444" class="l"><a class="l" href="#444">444: </a><span class="php-comment"> * To get Loggers, use the Logger::getLogger and Logger::getRootLogger |
| </span></span><span id="445" class="l"><a class="l" href="#445">445: </a><span class="php-comment"> * methods instead of operating on on the hierarchy directly. |
| </span></span><span id="446" class="l"><a class="l" href="#446">446: </a><span class="php-comment"> * |
| </span></span><span id="447" class="l"><a class="l" href="#447">447: </a><span class="php-comment"> * @return LoggerHierarchy |
| </span></span><span id="448" class="l"><a class="l" href="#448">448: </a><span class="php-comment"> */</span> |
| </span><span id="449" class="l"><a class="l" href="#449">449: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getHierarchy" href="#_getHierarchy">getHierarchy</a>() { |
| </span><span id="450" class="l"><a class="l" href="#450">450: </a> <span class="php-keyword1">if</span>(!<span class="php-keyword1">isset</span>(self::<span class="php-var">$hierarchy</span>)) { |
| </span><span id="451" class="l"><a class="l" href="#451">451: </a> self::<span class="php-var">$hierarchy</span> = <span class="php-keyword1">new</span> LoggerHierarchy(<span class="php-keyword1">new</span> LoggerRoot()); |
| </span><span id="452" class="l"><a class="l" href="#452">452: </a> } |
| </span><span id="453" class="l"><a class="l" href="#453">453: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$hierarchy</span>; |
| </span><span id="454" class="l"><a class="l" href="#454">454: </a> } |
| </span><span id="455" class="l"><a class="l" href="#455">455: </a> |
| </span><span id="456" class="l"><a class="l" href="#456">456: </a> <span class="php-comment">/** |
| </span></span><span id="457" class="l"><a class="l" href="#457">457: </a><span class="php-comment"> * Returns a Logger by name. If it does not exist, it will be created. |
| </span></span><span id="458" class="l"><a class="l" href="#458">458: </a><span class="php-comment"> * |
| </span></span><span id="459" class="l"><a class="l" href="#459">459: </a><span class="php-comment"> * @param string $name The logger name |
| </span></span><span id="460" class="l"><a class="l" href="#460">460: </a><span class="php-comment"> * @return Logger |
| </span></span><span id="461" class="l"><a class="l" href="#461">461: </a><span class="php-comment"> */</span> |
| </span><span id="462" class="l"><a class="l" href="#462">462: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getLogger" href="#_getLogger">getLogger</a>(<span class="php-var">$name</span>) { |
| </span><span id="463" class="l"><a class="l" href="#463">463: </a> <span class="php-keyword1">if</span>(!self::isInitialized()) { |
| </span><span id="464" class="l"><a class="l" href="#464">464: </a> self::configure(); |
| </span><span id="465" class="l"><a class="l" href="#465">465: </a> } |
| </span><span id="466" class="l"><a class="l" href="#466">466: </a> <span class="php-keyword1">return</span> self::getHierarchy()->getLogger(<span class="php-var">$name</span>); |
| </span><span id="467" class="l"><a class="l" href="#467">467: </a> } |
| </span><span id="468" class="l"><a class="l" href="#468">468: </a> |
| </span><span id="469" class="l"><a class="l" href="#469">469: </a> <span class="php-comment">/** |
| </span></span><span id="470" class="l"><a class="l" href="#470">470: </a><span class="php-comment"> * Returns the Root Logger. |
| </span></span><span id="471" class="l"><a class="l" href="#471">471: </a><span class="php-comment"> * @return LoggerRoot |
| </span></span><span id="472" class="l"><a class="l" href="#472">472: </a><span class="php-comment"> */</span> |
| </span><span id="473" class="l"><a class="l" href="#473">473: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getRootLogger" href="#_getRootLogger">getRootLogger</a>() { |
| </span><span id="474" class="l"><a class="l" href="#474">474: </a> <span class="php-keyword1">if</span>(!self::isInitialized()) { |
| </span><span id="475" class="l"><a class="l" href="#475">475: </a> self::configure(); |
| </span><span id="476" class="l"><a class="l" href="#476">476: </a> } |
| </span><span id="477" class="l"><a class="l" href="#477">477: </a> <span class="php-keyword1">return</span> self::getHierarchy()->getRootLogger(); |
| </span><span id="478" class="l"><a class="l" href="#478">478: </a> } |
| </span><span id="479" class="l"><a class="l" href="#479">479: </a> |
| </span><span id="480" class="l"><a class="l" href="#480">480: </a> <span class="php-comment">/** |
| </span></span><span id="481" class="l"><a class="l" href="#481">481: </a><span class="php-comment"> * Clears all Logger definitions from the logger hierarchy. |
| </span></span><span id="482" class="l"><a class="l" href="#482">482: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="483" class="l"><a class="l" href="#483">483: </a><span class="php-comment"> */</span> |
| </span><span id="484" class="l"><a class="l" href="#484">484: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_clear" href="#_clear">clear</a>() { |
| </span><span id="485" class="l"><a class="l" href="#485">485: </a> <span class="php-keyword1">return</span> self::getHierarchy()->clear(); |
| </span><span id="486" class="l"><a class="l" href="#486">486: </a> } |
| </span><span id="487" class="l"><a class="l" href="#487">487: </a> |
| </span><span id="488" class="l"><a class="l" href="#488">488: </a> <span class="php-comment">/** |
| </span></span><span id="489" class="l"><a class="l" href="#489">489: </a><span class="php-comment"> * Destroy configurations for logger definitions |
| </span></span><span id="490" class="l"><a class="l" href="#490">490: </a><span class="php-comment"> */</span> |
| </span><span id="491" class="l"><a class="l" href="#491">491: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_resetConfiguration" href="#_resetConfiguration">resetConfiguration</a>() { |
| </span><span id="492" class="l"><a class="l" href="#492">492: </a> self::getHierarchy()->resetConfiguration(); |
| </span><span id="493" class="l"><a class="l" href="#493">493: </a> self::getHierarchy()->clear(); <span class="php-comment">// TODO: clear or not?</span> |
| </span><span id="494" class="l"><a class="l" href="#494">494: </a> self::<span class="php-var">$initialized</span> = <span class="php-keyword1">false</span>; |
| </span><span id="495" class="l"><a class="l" href="#495">495: </a> } |
| </span><span id="496" class="l"><a class="l" href="#496">496: </a> |
| </span><span id="497" class="l"><a class="l" href="#497">497: </a> <span class="php-comment">/** |
| </span></span><span id="498" class="l"><a class="l" href="#498">498: </a><span class="php-comment"> * Safely close all appenders. |
| </span></span><span id="499" class="l"><a class="l" href="#499">499: </a><span class="php-comment"> * @deprecated This is no longer necessary due the appenders shutdown via |
| </span></span><span id="500" class="l"><a class="l" href="#500">500: </a><span class="php-comment"> * destructors. |
| </span></span><span id="501" class="l"><a class="l" href="#501">501: </a><span class="php-comment"> */</span> |
| </span><span id="502" class="l"><a class="l" href="#502">502: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_shutdown" href="#_shutdown">shutdown</a>() { |
| </span><span id="503" class="l"><a class="l" href="#503">503: </a> <span class="php-keyword1">return</span> self::getHierarchy()->shutdown(); |
| </span><span id="504" class="l"><a class="l" href="#504">504: </a> } |
| </span><span id="505" class="l"><a class="l" href="#505">505: </a> |
| </span><span id="506" class="l"><a class="l" href="#506">506: </a> <span class="php-comment">/** |
| </span></span><span id="507" class="l"><a class="l" href="#507">507: </a><span class="php-comment"> * check if a given logger exists. |
| </span></span><span id="508" class="l"><a class="l" href="#508">508: </a><span class="php-comment"> * |
| </span></span><span id="509" class="l"><a class="l" href="#509">509: </a><span class="php-comment"> * @param string $name logger name |
| </span></span><span id="510" class="l"><a class="l" href="#510">510: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="511" class="l"><a class="l" href="#511">511: </a><span class="php-comment"> */</span> |
| </span><span id="512" class="l"><a class="l" href="#512">512: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_exists" href="#_exists">exists</a>(<span class="php-var">$name</span>) { |
| </span><span id="513" class="l"><a class="l" href="#513">513: </a> <span class="php-keyword1">return</span> self::getHierarchy()->exists(<span class="php-var">$name</span>); |
| </span><span id="514" class="l"><a class="l" href="#514">514: </a> } |
| </span><span id="515" class="l"><a class="l" href="#515">515: </a> |
| </span><span id="516" class="l"><a class="l" href="#516">516: </a> <span class="php-comment">/** |
| </span></span><span id="517" class="l"><a class="l" href="#517">517: </a><span class="php-comment"> * Returns an array this whole Logger instances. |
| </span></span><span id="518" class="l"><a class="l" href="#518">518: </a><span class="php-comment"> * @see Logger |
| </span></span><span id="519" class="l"><a class="l" href="#519">519: </a><span class="php-comment"> * @return array |
| </span></span><span id="520" class="l"><a class="l" href="#520">520: </a><span class="php-comment"> */</span> |
| </span><span id="521" class="l"><a class="l" href="#521">521: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getCurrentLoggers" href="#_getCurrentLoggers">getCurrentLoggers</a>() { |
| </span><span id="522" class="l"><a class="l" href="#522">522: </a> <span class="php-keyword1">return</span> self::getHierarchy()->getCurrentLoggers(); |
| </span><span id="523" class="l"><a class="l" href="#523">523: </a> } |
| </span><span id="524" class="l"><a class="l" href="#524">524: </a> |
| </span><span id="525" class="l"><a class="l" href="#525">525: </a> <span class="php-comment">/** |
| </span></span><span id="526" class="l"><a class="l" href="#526">526: </a><span class="php-comment"> * Configures log4php. |
| </span></span><span id="527" class="l"><a class="l" href="#527">527: </a><span class="php-comment"> * |
| </span></span><span id="528" class="l"><a class="l" href="#528">528: </a><span class="php-comment"> * This method needs to be called before the first logging event has |
| </span></span><span id="529" class="l"><a class="l" href="#529">529: </a><span class="php-comment"> * occured. If this method is not called before then the default |
| </span></span><span id="530" class="l"><a class="l" href="#530">530: </a><span class="php-comment"> * configuration will be used. |
| </span></span><span id="531" class="l"><a class="l" href="#531">531: </a><span class="php-comment"> * |
| </span></span><span id="532" class="l"><a class="l" href="#532">532: </a><span class="php-comment"> * @param string|array $configuration Either a path to the configuration |
| </span></span><span id="533" class="l"><a class="l" href="#533">533: </a><span class="php-comment"> * file, or a configuration array. |
| </span></span><span id="534" class="l"><a class="l" href="#534">534: </a><span class="php-comment"> * |
| </span></span><span id="535" class="l"><a class="l" href="#535">535: </a><span class="php-comment"> * @param string|LoggerConfigurator $configurator A custom |
| </span></span><span id="536" class="l"><a class="l" href="#536">536: </a><span class="php-comment"> * configurator class: either a class name (string), or an object which |
| </span></span><span id="537" class="l"><a class="l" href="#537">537: </a><span class="php-comment"> * implements the LoggerConfigurator interface. If left empty, the default |
| </span></span><span id="538" class="l"><a class="l" href="#538">538: </a><span class="php-comment"> * configurator implementation will be used. |
| </span></span><span id="539" class="l"><a class="l" href="#539">539: </a><span class="php-comment"> */</span> |
| </span><span id="540" class="l"><a class="l" href="#540">540: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_configure" href="#_configure">configure</a>(<span class="php-var">$configuration</span> = <span class="php-keyword1">null</span>, <span class="php-var">$configurator</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="541" class="l"><a class="l" href="#541">541: </a> self::resetConfiguration(); |
| </span><span id="542" class="l"><a class="l" href="#542">542: </a> <span class="php-var">$configurator</span> = self::getConfigurator(<span class="php-var">$configurator</span>); |
| </span><span id="543" class="l"><a class="l" href="#543">543: </a> <span class="php-var">$configurator</span>->configure(self::getHierarchy(), <span class="php-var">$configuration</span>); |
| </span><span id="544" class="l"><a class="l" href="#544">544: </a> self::<span class="php-var">$initialized</span> = <span class="php-keyword1">true</span>; |
| </span><span id="545" class="l"><a class="l" href="#545">545: </a> } |
| </span><span id="546" class="l"><a class="l" href="#546">546: </a> |
| </span><span id="547" class="l"><a class="l" href="#547">547: </a> <span class="php-comment">/** |
| </span></span><span id="548" class="l"><a class="l" href="#548">548: </a><span class="php-comment"> * Creates a logger configurator instance based on the provided |
| </span></span><span id="549" class="l"><a class="l" href="#549">549: </a><span class="php-comment"> * configurator class. If no class is given, returns an instance of |
| </span></span><span id="550" class="l"><a class="l" href="#550">550: </a><span class="php-comment"> * the default configurator. |
| </span></span><span id="551" class="l"><a class="l" href="#551">551: </a><span class="php-comment"> * |
| </span></span><span id="552" class="l"><a class="l" href="#552">552: </a><span class="php-comment"> * @param string|LoggerConfigurator $configurator The configurator class |
| </span></span><span id="553" class="l"><a class="l" href="#553">553: </a><span class="php-comment"> * or LoggerConfigurator instance. |
| </span></span><span id="554" class="l"><a class="l" href="#554">554: </a><span class="php-comment"> */</span> |
| </span><span id="555" class="l"><a class="l" href="#555">555: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getConfigurator" href="#_getConfigurator">getConfigurator</a>(<span class="php-var">$configurator</span> = <span class="php-keyword1">null</span>) { |
| </span><span id="556" class="l"><a class="l" href="#556">556: </a> <span class="php-keyword1">if</span> (<span class="php-var">$configurator</span> === <span class="php-keyword1">null</span>) { |
| </span><span id="557" class="l"><a class="l" href="#557">557: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> LoggerConfiguratorDefault(); |
| </span><span id="558" class="l"><a class="l" href="#558">558: </a> } |
| </span><span id="559" class="l"><a class="l" href="#559">559: </a> |
| </span><span id="560" class="l"><a class="l" href="#560">560: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_object</span>(<span class="php-var">$configurator</span>)) { |
| </span><span id="561" class="l"><a class="l" href="#561">561: </a> <span class="php-keyword1">if</span> (<span class="php-var">$configurator</span> <span class="php-keyword1">instanceof</span> LoggerConfigurator) { |
| </span><span id="562" class="l"><a class="l" href="#562">562: </a> <span class="php-keyword1">return</span> <span class="php-var">$configurator</span>; |
| </span><span id="563" class="l"><a class="l" href="#563">563: </a> } <span class="php-keyword1">else</span> { |
| </span><span id="564" class="l"><a class="l" href="#564">564: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"log4php: Given configurator object [</span><span class="php-var">$configurator</span><span class="php-quote">] does not implement the LoggerConfigurator interface. Reverting to default configurator."</span>, E_USER_WARNING); |
| </span><span id="565" class="l"><a class="l" href="#565">565: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> LoggerConfiguratorDefault(); |
| </span><span id="566" class="l"><a class="l" href="#566">566: </a> } |
| </span><span id="567" class="l"><a class="l" href="#567">567: </a> } |
| </span><span id="568" class="l"><a class="l" href="#568">568: </a> |
| </span><span id="569" class="l"><a class="l" href="#569">569: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_string</span>(<span class="php-var">$configurator</span>)) { |
| </span><span id="570" class="l"><a class="l" href="#570">570: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">class_exists</span>(<span class="php-var">$configurator</span>)) { |
| </span><span id="571" class="l"><a class="l" href="#571">571: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"log4php: Specified configurator class [</span><span class="php-var">$configurator</span><span class="php-quote">] does not exist. Reverting to default configurator."</span>, E_USER_WARNING); |
| </span><span id="572" class="l"><a class="l" href="#572">572: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> LoggerConfiguratorDefault(); |
| </span><span id="573" class="l"><a class="l" href="#573">573: </a> } |
| </span><span id="574" class="l"><a class="l" href="#574">574: </a> |
| </span><span id="575" class="l"><a class="l" href="#575">575: </a> <span class="php-var">$instance</span> = <span class="php-keyword1">new</span> <span class="php-var">$configurator</span>(); |
| </span><span id="576" class="l"><a class="l" href="#576">576: </a> |
| </span><span id="577" class="l"><a class="l" href="#577">577: </a> <span class="php-keyword1">if</span> (!(<span class="php-var">$instance</span> <span class="php-keyword1">instanceof</span> LoggerConfigurator)) { |
| </span><span id="578" class="l"><a class="l" href="#578">578: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"log4php: Specified configurator class [</span><span class="php-var">$configurator</span><span class="php-quote">] does not implement the LoggerConfigurator interface. Reverting to default configurator."</span>, E_USER_WARNING); |
| </span><span id="579" class="l"><a class="l" href="#579">579: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> LoggerConfiguratorDefault(); |
| </span><span id="580" class="l"><a class="l" href="#580">580: </a> } |
| </span><span id="581" class="l"><a class="l" href="#581">581: </a> |
| </span><span id="582" class="l"><a class="l" href="#582">582: </a> <span class="php-keyword1">return</span> <span class="php-var">$instance</span>; |
| </span><span id="583" class="l"><a class="l" href="#583">583: </a> } |
| </span><span id="584" class="l"><a class="l" href="#584">584: </a> |
| </span><span id="585" class="l"><a class="l" href="#585">585: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-quote">"log4php: Invalid configurator specified. Expected either a string or a LoggerConfigurator instance. Reverting to default configurator."</span>, E_USER_WARNING); |
| </span><span id="586" class="l"><a class="l" href="#586">586: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> LoggerConfiguratorDefault(); |
| </span><span id="587" class="l"><a class="l" href="#587">587: </a> } |
| </span><span id="588" class="l"><a class="l" href="#588">588: </a> |
| </span><span id="589" class="l"><a class="l" href="#589">589: </a> <span class="php-comment">/** |
| </span></span><span id="590" class="l"><a class="l" href="#590">590: </a><span class="php-comment"> * Returns true if the log4php framework has been initialized. |
| </span></span><span id="591" class="l"><a class="l" href="#591">591: </a><span class="php-comment"> * @return boolean |
| </span></span><span id="592" class="l"><a class="l" href="#592">592: </a><span class="php-comment"> */</span> |
| </span><span id="593" class="l"><a class="l" href="#593">593: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_isInitialized" href="#_isInitialized">isInitialized</a>() { |
| </span><span id="594" class="l"><a class="l" href="#594">594: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$initialized</span>; |
| </span><span id="595" class="l"><a class="l" href="#595">595: </a> } |
| </span><span id="596" class="l"><a class="l" href="#596">596: </a>} |
| </span><span id="597" class="l"><a class="l" href="#597">597: </a></span></code></pre> |
| |
| <div id="footer"> |
| Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
