| <?xml version="1.0" encoding="iso-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <!-- template designed by Marco Von Ballmoos --> |
| <title>Docs For Class LoggerAppenderDailyFile</title> |
| <link rel="stylesheet" href="../../media/stylesheet.css" /> |
| <script src="../../media/lib/classTree.js"></script> |
| <script language="javascript" type="text/javascript"> |
| var imgPlus = new Image(); |
| var imgMinus = new Image(); |
| imgPlus.src = "../../media/images/plus.png"; |
| imgMinus.src = "../../media/images/minus.png"; |
| |
| function showNode(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| var oImg = document.layers["img" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| var oImg = document.all["img" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| var oImg = document.getElementById("img" + Node); |
| break; |
| } |
| oImg.src = imgMinus.src; |
| oTable.style.display = "block"; |
| } |
| |
| function hideNode(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| var oImg = document.layers["img" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| var oImg = document.all["img" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| var oImg = document.getElementById("img" + Node); |
| break; |
| } |
| oImg.src = imgPlus.src; |
| oTable.style.display = "none"; |
| } |
| |
| function nodeIsVisible(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| break; |
| } |
| return (oTable && oTable.style.display == "block"); |
| } |
| |
| function toggleNodeVisibility(Node){ |
| if (nodeIsVisible(Node)){ |
| hideNode(Node); |
| }else{ |
| showNode(Node); |
| } |
| } |
| </script> |
| </head> |
| <body> |
| <div class="page-body"> |
| <h2 class="class-name">Class LoggerAppenderDailyFile</h2> |
| |
| <a name="sec-description"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Description</div> |
| <div class="nav-bar"> |
| <span class="disabled">Description</span> | |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">An Appender that automatically creates a new logfile each day.</p> |
| <p class="description"><p>The file is rolled over once a day. That means, for each day a new file is created. A formatted version of the date pattern is used as to create the file name using the <a href="http://www.php.net/sprintf">http://www.php.net/sprintf</a> function.</p><p>This appender uses a layout.</p><p>Configurable parameters for this appender are: <ul><li>datePattern - The date format for the file name. Should be set before |
| $file. Default value: "Ymd".</li><li>file - The path to the target log file. The filename should |
| contain a '%s' which will be substituted by the date.</li><li>append - Sets if the appender should append to the end of the |
| file or overwrite content ("true" or "false"). Default |
| value: true.</li></ul> An example php file:</p><p><div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once </span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../../main/php/Logger.php'</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"><span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodconfigure">configure</a><span class="src-sym">(</span><a href="http://www.php.net/dirname">dirname</a><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../resources/appender_dailyfile.properties'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"> </div></li> |
| <li><div class="src-line"><span class="src-var">$logger </span>= <span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodgetRootLogger">getRootLogger</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"><span class="src-var">$logger</span><span class="src-sym">-></span><span class="src-id">debug</span><span class="src-sym">(</span><span class="src-str">"Hello World!"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| </ol></div></p><p>An example configuration file:</p><p><div class="src-code"><ol><li><div class="src-line">log4php.appender.default = LoggerAppenderDailyFile</div></li> |
| <li><div class="src-line">log4php.appender.default.layout = LoggerLayoutTTCC</div></li> |
| <li><div class="src-line">log4php.appender.default.datePattern = Ymd</div></li> |
| <li><div class="src-line">log4php.appender.default.file = target/examples/daily_%s.log</div></li> |
| <li><div class="src-line">log4php.rootLogger = DEBUG, default</div></li> |
| </ol></div></p><p>The above will create a file like: daily_20090908.log</p></p> |
| <ul class="tags"> |
| <li><span class="field">version:</span> $Revision: 1213283 $</li> |
| </ul> |
| <p class="notes"> |
| Located in <a class="field" href="_appenders---LoggerAppenderDailyFile.php.html">/appenders/LoggerAppenderDailyFile.php</a> (line <span class="field">53</span>) |
| </p> |
| |
| |
| <pre><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a> |
| | |
| --<a href="../../log4php/LoggerAppender.html">LoggerAppender</a> |
| | |
| --<a href="../../log4php/appenders/LoggerAppenderFile.html">LoggerAppenderFile</a> |
| | |
| --LoggerAppenderDailyFile</pre> |
| |
| </div> |
| </div> |
| |
| |
| |
| <a name="sec-var-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Variable Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <div class="var-summary"> |
| <div class="var-title"> |
| <span class="var-type">string</span> |
| <a href="#$datePattern" title="details" class="var-name">$datePattern</a> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <a name="sec-method-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Method Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| |
| | |
| <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <div class="method-summary"> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#activateOptions" title="details" class="method-name">activateOptions</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">string</span> |
| <a href="#getDatePattern" title="details" class="method-name">getDatePattern</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setDatePattern" title="details" class="method-name">setDatePattern</a> |
| (<span class="var-type">string</span> <span class="var-name">$datePattern</span>) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <a name="sec-vars"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Variables</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| |
| |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <a name="var$datePattern" id="$datePattern"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">string</span> |
| <span class="var-name">$datePattern</span> |
| = <span class="var-default"> "Ymd"</span> (line <span class="line-number">60</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Format date.</p> |
| <p class="description"><p>It follows the <a href="http://www.php.net/date()">http://www.php.net/date()</a> formatting rules and <strong>should always be set before <a href="../../log4php/appenders/LoggerAppenderFile.html#var$file">$file</a> param</strong>.</p></p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <h4>Inherited Variables</h4> |
| <A NAME='inherited_vars'><!-- --></A> |
| <p>Inherited from <span class="classname"><a href="../../log4php/appenders/LoggerAppenderFile.html">LoggerAppenderFile</a></span></p> |
| <blockquote> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#var$append">LoggerAppenderFile::$append</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#var$file">LoggerAppenderFile::$file</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#var$fp">LoggerAppenderFile::$fp</a></span><br> |
| </span> |
| </blockquote> |
| <p>Inherited from <span class="classname"><a href="../../log4php/LoggerAppender.html">LoggerAppender</a></span></p> |
| <blockquote> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$closed">LoggerAppender::$closed</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$filter">LoggerAppender::$filter</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$layout">LoggerAppender::$layout</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$name">LoggerAppender::$name</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$requiresLayout">LoggerAppender::$requiresLayout</a></span><br> |
| </span> |
| <span class="var-title"> |
| <span class="var-name"><a href="../../log4php/LoggerAppender.html#var$threshold">LoggerAppender::$threshold</a></span><br> |
| </span> |
| </blockquote> |
| |
| </div> |
| </div> |
| |
| <a name="sec-methods"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Methods</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| |
| </div> |
| <div class="info-box-body"> |
| <A NAME='method_detail'></A> |
| <a name="methodactivateOptions" id="activateOptions"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">activateOptions</span> (line <span class="line-number">81</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Similar to parent method, but but replaces "%s" in the file name with the current date in format specified by the 'datePattern' parameter.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| activateOptions |
| </span> |
| () |
| </div> |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/appenders/LoggerAppenderFile.html#methodactivateOptions">LoggerAppenderFile::activateOptions()</a></dt> |
| </dl> |
| |
| </div> |
| <a name="methodgetDatePattern" id="getDatePattern"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getDatePattern</span> (line <span class="line-number">73</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <ul class="tags"> |
| <li><span class="field">return:</span> returns date format for the filename</li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">string</span> |
| <span class="method-name"> |
| getDatePattern |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodsetDatePattern" id="setDatePattern"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setDatePattern</span> (line <span class="line-number">66</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Sets date format for the file name.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| setDatePattern |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$datePattern</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$datePattern</span><span class="var-description">: a regular date() string format</span> </li> |
| </ul> |
| |
| |
| </div> |
| <h4>Inherited Methods</h4> |
| <a name='inherited_methods'><!-- --></a> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../../log4php/appenders/LoggerAppenderFile.html">LoggerAppenderFile</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodactivateOptions">LoggerAppenderFile::activateOptions()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodappend">LoggerAppenderFile::append()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodclose">LoggerAppenderFile::close()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodgetAppend">LoggerAppenderFile::getAppend()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodgetFile">LoggerAppenderFile::getFile()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodgetFileName">LoggerAppenderFile::getFileName()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodsetAppend">LoggerAppenderFile::setAppend()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodsetFile">LoggerAppenderFile::setFile()</a></span><br> |
| <span class="method-name"><a href="../../log4php/appenders/LoggerAppenderFile.html#methodsetFileName">LoggerAppenderFile::setFileName()</a></span><br> |
| </blockquote> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../../log4php/LoggerAppender.html">LoggerAppender</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#method__construct">LoggerAppender::__construct()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodactivateOptions">LoggerAppender::activateOptions()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodaddFilter">LoggerAppender::addFilter()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodappend">LoggerAppender::append()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodclearFilters">LoggerAppender::clearFilters()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodclose">LoggerAppender::close()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methoddoAppend">LoggerAppender::doAppend()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetDefaultLayout">LoggerAppender::getDefaultLayout()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetFilter">LoggerAppender::getFilter()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetFirstFilter">LoggerAppender::getFirstFilter()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetLayout">LoggerAppender::getLayout()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetName">LoggerAppender::getName()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetThreshold">LoggerAppender::getThreshold()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodisAsSevereAsThreshold">LoggerAppender::isAsSevereAsThreshold()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodrequiresLayout">LoggerAppender::requiresLayout()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodsetLayout">LoggerAppender::setLayout()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodsetName">LoggerAppender::setName()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodsetThreshold">LoggerAppender::setThreshold()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerAppender.html#methodwarn">LoggerAppender::warn()</a></span><br> |
| </blockquote> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetBoolean">LoggerConfigurable::setBoolean()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetFileSize">LoggerConfigurable::setFileSize()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetInteger">LoggerConfigurable::setInteger()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetLevel">LoggerConfigurable::setLevel()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetNumeric">LoggerConfigurable::setNumeric()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetPositiveInteger">LoggerConfigurable::setPositiveInteger()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetString">LoggerConfigurable::setString()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodwarn">LoggerConfigurable::warn()</a></span><br> |
| </blockquote> |
| |
| </div> |
| </div> |
| |
| |
| <p class="notes" id="credit"> |
| Documentation generated on Sat, 18 Feb 2012 22:32:21 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
