| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="ApiGen 2.8.0" /> |
| |
| <title>Class LoggerAppenderPool | 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><a href="class-Logger.html">Logger</a></li> |
| <li><a href="class-LoggerAppender.html">LoggerAppender</a></li> |
| <li class="active"><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 class="active"> |
| <span>Class</span> </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> |
| |
| <div id="content" class="class"> |
| <h1>Class LoggerAppenderPool</h1> |
| |
| |
| <div class="description"> |
| |
| <p>Pool implmentation for LoggerAppender instances.</p> |
| |
| <p>The pool is used when configuring log4php. First all appender instances are |
| created in the pool. Afterward, they are linked to loggers, each appender can be |
| linked to multiple loggers. This makes sure duplicate appenders are not |
| created.</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="info"> |
| |
| |
| |
| <b>Package:</b> <a href="package-log4php.html">log4php</a><br /> |
| |
| <b>Version:</b> |
| $Revision: 1350602 $<br /> |
| <b>Located at</b> <a href="source-class-LoggerAppenderPool.html#21-98" title="Go to source code">LoggerAppenderPool.php</a><br /> |
| </div> |
| |
| |
| |
| <table class="summary" id="methods"> |
| <caption>Methods summary</caption> |
| <tr data-order="add" id="_add"> |
| |
| <td class="attributes"><code> |
| public static |
| |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_add">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#37-55" title="Go to source code">add</a>( <span><code><a href="class-LoggerAppender.html">LoggerAppender</a></code> <var>$appender</var></span> )</code> |
| |
| <div class="description short"> |
| |
| <p>Adds an appender to the pool. The appender must be named for this |
| operation.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Adds an appender to the pool. The appender must be named for this |
| operation.</p> |
| |
| |
| |
| <h4>Parameters</h4> |
| <div class="list"><dl> |
| <dt><var>$appender</var></dt> |
| <dd><code><code><a href="class-LoggerAppender.html">LoggerAppender</a></code></code><br>$appender</dd> |
| </dl></div> |
| |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| <tr data-order="get" id="_get"> |
| |
| <td class="attributes"><code> |
| public static |
| <code><a href="class-LoggerAppender.html">LoggerAppender</a></code> |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_get">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#57-65" title="Go to source code">get</a>( <span>string <var>$name</var></span> )</code> |
| |
| <div class="description short"> |
| |
| <p>Retrieves an appender from the pool by name.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Retrieves an appender from the pool by name.</p> |
| |
| |
| |
| <h4>Parameters</h4> |
| <div class="list"><dl> |
| <dt><var>$name</var></dt> |
| <dd><code>string</code><br>$name Name of the appender to retrieve.</dd> |
| </dl></div> |
| |
| <h4>Returns</h4> |
| <div class="list"> |
| <code><code><a href="class-LoggerAppender.html">LoggerAppender</a></code></code><br>The named appender or NULL if no such appender exists in the pool.<br /> |
| </div> |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| <tr data-order="delete" id="_delete"> |
| |
| <td class="attributes"><code> |
| public static |
| |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_delete">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#67-73" title="Go to source code">delete</a>( <span>string <var>$name</var></span> )</code> |
| |
| <div class="description short"> |
| |
| <p>Removes an appender from the pool by name.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Removes an appender from the pool by name.</p> |
| |
| |
| |
| <h4>Parameters</h4> |
| <div class="list"><dl> |
| <dt><var>$name</var></dt> |
| <dd><code>string</code><br>$name Name of the appender to remove.</dd> |
| </dl></div> |
| |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| <tr data-order="getAppenders" id="_getAppenders"> |
| |
| <td class="attributes"><code> |
| public static |
| array |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_getAppenders">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#75-81" title="Go to source code">getAppenders</a>( )</code> |
| |
| <div class="description short"> |
| |
| <p>Returns all appenders from the pool.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Returns all appenders from the pool.</p> |
| |
| |
| |
| |
| <h4>Returns</h4> |
| <div class="list"> |
| <code>array</code><br>Array of LoggerAppender objects.<br /> |
| </div> |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| <tr data-order="exists" id="_exists"> |
| |
| <td class="attributes"><code> |
| public static |
| boolean |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_exists">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#83-90" title="Go to source code">exists</a>( <span>string <var>$name</var></span> )</code> |
| |
| <div class="description short"> |
| |
| <p>Checks whether an appender exists in the pool.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Checks whether an appender exists in the pool.</p> |
| |
| |
| |
| <h4>Parameters</h4> |
| <div class="list"><dl> |
| <dt><var>$name</var></dt> |
| <dd><code>string</code><br>$name Name of the appender to look for.</dd> |
| </dl></div> |
| |
| <h4>Returns</h4> |
| <div class="list"> |
| <code>boolean</code><br>TRUE if the appender with the given name exists.<br /> |
| </div> |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| <tr data-order="clear" id="_clear"> |
| |
| <td class="attributes"><code> |
| public static |
| |
| |
| </code> |
| </td> |
| |
| <td class="name"><div> |
| <a class="anchor" href="#_clear">#</a> |
| <code><a href="source-class-LoggerAppenderPool.html#92-97" title="Go to source code">clear</a>( )</code> |
| |
| <div class="description short"> |
| |
| <p>Clears all appenders from the pool.</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Clears all appenders from the pool.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <table class="summary" id="properties"> |
| <caption>Properties summary</caption> |
| <tr data-order="appenders" id="$appenders"> |
| <td class="attributes"><code> |
| public static |
| array |
| </code></td> |
| |
| <td class="name"> |
| <a href="source-class-LoggerAppenderPool.html#34-35" title="Go to source code"><var>$appenders</var></a> |
| </td> |
| <td class="value"><code><span class="php-keyword1">array</span>()</code></td> |
| <td class="description"><div> |
| <a href="#$appenders" class="anchor">#</a> |
| |
| <div class="description short"> |
| |
| <p>Holds appenders indexed by their name</p> |
| |
| </div> |
| |
| <div class="description detailed hidden"> |
| |
| <p>Holds appenders indexed by their name</p> |
| |
| |
| </div> |
| </div></td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| <div id="footer"> |
| Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
