| <?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 LoggerAppenderRollingFile</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 LoggerAppenderRollingFile</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">LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log files when they reach a certain size.</p> |
| <p class="description"><p>This appender uses a layout.</p><p>Parameters are: <ul><li>file - The target file to write to</li><li>filename - The target file to write to (deprecated, use "file" instead).</li><li>append - Sets if the appender should append to the end of the file or overwrite content ("true" or "false")</li><li>maxBackupIndex - Set the maximum number of backup files to keep around (int)</li><li>maxFileSize - Set the maximum size that the output file is allowed to |
| reach before being rolled over to backup files. |
| Suffixes like "KB", "MB" or "GB" are allowed, f. e. "10KB" is interpreted as 10240</li><li>maximumFileSize - Alias to maxFileSize (deprecated, use "maxFileSize" instead)</li></ul> <p>Contributors: Sergio Strampelli.</p></p><p>An example:</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"> </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_socket.properties'</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-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">fatal</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><div class="src-code"><ol><li><div class="src-line">log4php.appender.default = LoggerAppenderSocket</div></li> |
| <li><div class="src-line">log4php.appender.default.layout = LoggerLayoutSimple</div></li> |
| <li><div class="src-line">log4php.appender.default.remoteHost = localhost</div></li> |
| <li><div class="src-line">log4php.appender.default.port = 4242</div></li> |
| <li><div class="src-line">log4php.appender.default.useXml = true</div></li> |
| <li><div class="src-line">log4php.appender.default.locationInfo = false</div></li> |
| <li><div class="src-line">log4php.rootLogger = DEBUG, default</div></li> |
| </ol></div></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---LoggerAppenderRollingFile.php.html">/appenders/LoggerAppenderRollingFile.php</a> (line <span class="field">49</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> |
| | |
| --LoggerAppenderRollingFile</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="#$expandedFileName" title="details" class="var-name">$expandedFileName</a> |
| </div> |
| <div class="var-title"> |
| <span class="var-type">integer</span> |
| <a href="#$maxBackupIndex" title="details" class="var-name">$maxBackupIndex</a> |
| </div> |
| <div class="var-title"> |
| <span class="var-type">integer</span> |
| <a href="#$maxFileSize" title="details" class="var-name">$maxFileSize</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="#append" title="details" class="method-name">append</a> |
| (<span class="var-type"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> <span class="var-name">$event</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">integer</span> |
| <a href="#getExpandedFileName" title="details" class="method-name">getExpandedFileName</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">Returns</span> |
| <a href="#getMaxBackupIndex" title="details" class="method-name">getMaxBackupIndex</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">Returns</span> |
| <a href="#getMaxFileSize" title="details" class="method-name">getMaxFileSize</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">integer</span> |
| <a href="#getMaximumFileSize" title="details" class="method-name">getMaximumFileSize</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#rollOver" title="details" class="method-name">rollOver</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setFile" title="details" class="method-name">setFile</a> |
| (<span class="var-type"></span> <span class="var-name">$fileName</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setMaxBackupIndex" title="details" class="method-name">setMaxBackupIndex</a> |
| (<span class="var-type">mixed</span> <span class="var-name">$maxBackups</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">the</span> |
| <a href="#setMaxFileSize" title="details" class="method-name">setMaxFileSize</a> |
| (<span class="var-type">mixed</span> <span class="var-name">$value</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setMaximumFileSize" title="details" class="method-name">setMaximumFileSize</a> |
| (<span class="var-type">mixed</span> <span class="var-name">$maxFileSize</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$expandedFileName" id="$expandedFileName"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">string</span> |
| <span class="var-name">$expandedFileName</span> |
| = <span class="var-default"> null</span> (line <span class="line-number">86</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <ul class="tags"> |
| <li><span class="field">var:</span> the filename expanded</li> |
| <li><span class="field">access:</span> private</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <a name="var$maxBackupIndex" id="$maxBackupIndex"><!-- --></A> |
| <div class="oddrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">integer</span> |
| <span class="var-name">$maxBackupIndex</span> |
| = <span class="var-default"> 1</span> (line <span class="line-number">81</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Set the maximum number of backup files to keep around.</p> |
| <p class="description"><p>The <var>MaxBackupIndex</var> option determines how many backup files are kept before the oldest is erased. This option takes a positive integer value. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.</p><p>There is one backup file by default.</p><p></p></p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <a name="var$maxFileSize" id="$maxFileSize"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">integer</span> |
| <span class="var-name">$maxFileSize</span> |
| = <span class="var-default"> 10485760</span> (line <span class="line-number">67</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Set the maximum size that the output file is allowed to reach before being rolled over to backup files.</p> |
| <p class="description"><p>In configuration files, the <var>MaxFileSize</var> option takes a long integer in the range 0 - 2^63. You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is interpreted being expressed respectively in kilobytes, megabytes or gigabytes. For example, the value "10KB" will be interpreted as 10240.</p><p>The default maximum file size is 10MB.</p><p>Note that MaxFileSize cannot exceed <strong>2 GB</strong>.</p><p></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="methodappend" id="append"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">append</span> (line <span class="line-number">197</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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"> |
| append |
| </span> |
| (<span class="var-type"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> <span class="var-name">$event</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> |
| <span class="var-name">$event</span> </li> |
| </ul> |
| |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/appenders/LoggerAppenderFile.html#methodappend">LoggerAppenderFile::append()</a></dt> |
| </dl> |
| |
| </div> |
| <a name="methodgetExpandedFileName" id="getExpandedFileName"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getExpandedFileName</span> (line <span class="line-number">92</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Returns the value of the MaxBackupIndex option.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> private</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">integer</span> |
| <span class="method-name"> |
| getExpandedFileName |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodgetMaxBackupIndex" id="getMaxBackupIndex"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getMaxBackupIndex</span> (line <span class="line-number">220</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <ul class="tags"> |
| <li><span class="field">return:</span> the maximum number of backup files to keep around.</li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">Returns</span> |
| <span class="method-name"> |
| getMaxBackupIndex |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodgetMaxFileSize" id="getMaxFileSize"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getMaxFileSize</span> (line <span class="line-number">228</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <ul class="tags"> |
| <li><span class="field">return:</span> the maximum size that the output file is allowed to reach before being rolled over to backup files.</li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">Returns</span> |
| <span class="method-name"> |
| getMaxFileSize |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodgetMaximumFileSize" id="getMaximumFileSize"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getMaximumFileSize</span> (line <span class="line-number">101</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Get the maximum size that the output file is allowed to reach before being rolled over to backup files.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">integer</span> |
| <span class="method-name"> |
| getMaximumFileSize |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodrollOver" id="rollOver"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">rollOver</span> (line <span class="line-number">115</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Implements the usual roll over behaviour.</p> |
| <p class="description"><p>If MaxBackupIndex is positive, then files File.1, ..., File.MaxBackupIndex -1 are renamed to File.2, ..., File.MaxBackupIndex. Moreover, File is renamed File.1 and closed. A new File is created to receive further log output.</p><p>If MaxBackupIndex is equal to zero, then the File is truncated with no backup files created. Rollover must be called while the file is locked so that it is safe for concurrent access.</p></p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> private</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| rollOver |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodsetFile" id="setFile"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setFile</span> (line <span class="line-number">143</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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"> |
| setFile |
| </span> |
| (<span class="var-type"></span> <span class="var-name">$fileName</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type"></span> |
| <span class="var-name">$fileName</span> </li> |
| </ul> |
| |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/appenders/LoggerAppenderFile.html#methodsetFile">LoggerAppenderFile::setFile()</a></dt> |
| <dd>Sets the file where the log output will go.</dd> |
| </dl> |
| |
| </div> |
| <a name="methodsetMaxBackupIndex" id="setMaxBackupIndex"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setMaxBackupIndex</span> (line <span class="line-number">164</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Set the maximum number of backup files to keep around.</p> |
| <p class="description"><p>The <strong>MaxBackupIndex</strong> option determines how many backup files are kept before the oldest is erased. This option takes a positive integer value. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.</p></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"> |
| setMaxBackupIndex |
| </span> |
| (<span class="var-type">mixed</span> <span class="var-name">$maxBackups</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$maxBackups</span> </li> |
| </ul> |
| |
| |
| </div> |
| <a name="methodsetMaxFileSize" id="setMaxFileSize"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setMaxFileSize</span> (line <span class="line-number">193</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Set the maximum size that the output file is allowed to reach before being rolled over to backup files.</p> |
| <p class="description"><p>In configuration files, the <strong>maxFileSize</strong> option takes an long integer in the range 0 - 2^63. You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is interpreted being expressed respectively in kilobytes, megabytes or gigabytes. For example, the value "10KB" will be interpreted as 10240.</p></p> |
| <ul class="tags"> |
| <li><span class="field">return:</span> actual file size set</li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">the</span> |
| <span class="method-name"> |
| setMaxFileSize |
| </span> |
| (<span class="var-type">mixed</span> <span class="var-name">$value</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$value</span> </li> |
| </ul> |
| |
| |
| </div> |
| <a name="methodsetMaximumFileSize" id="setMaximumFileSize"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setMaximumFileSize</span> (line <span class="line-number">176</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Set the maximum size that the output file is allowed to reach before being rolled over to backup files.</p> |
| <ul class="tags"> |
| <li><span class="field">see:</span> <a href="../../log4php/appenders/LoggerAppenderRollingFile.html#methodsetMaxFileSize">LoggerAppenderRollingFile::setMaxFileSize()</a></li> |
| <li><span class="field">deprecated:</span> </li> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| setMaximumFileSize |
| </span> |
| (<span class="var-type">mixed</span> <span class="var-name">$maxFileSize</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$maxFileSize</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:23 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
