Author: ihabunek
Date: Sun May 13 09:25:14 2012
New Revision: 1337820
URL: http://svn.apache.org/viewvc?rev=1337820&view=rev
Log:
Improved appender phpdocs to work better with new phpdoc 2.0. No code changes.
Modified:
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderConsole.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderDailyFile.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderEcho.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFile.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFirephp.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMail.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMailEvent.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMongoDB.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderNull.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPDO.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPhp.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderRollingFile.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSocket.php
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSyslog.php
logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml
logging/log4php/trunk/src/test/php/appenders/LoggerAppenderMailEventTest.php
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderConsole.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderConsole.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderConsole.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderConsole.php Sun
May 13 09:25:14 2012
@@ -14,70 +14,44 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * ConsoleAppender appends log events to STDOUT or STDERR.
+ * LoggerAppenderConsole appends log events either to the standard output
+ * stream (php://stdout) or the standard error stream (php://stderr).
*
- * <p><b>Note</b>: Use this Appender with command-line php scripts.
- * On web scripts this appender has no effects.</p>
+ * **Note**: Use this Appender with command-line php scripts. On web scripts
+ * this appender has no effects.
*
- * Configurable parameters of this appender are:
+ * This appender uses a layout.
*
- * - layout - The layout (required)
- * - target - "stdout" or "stderr"
- *
- * An example php file:
- *
- * {@example ../../examples/php/appender_console.php 19}
- *
- * An example configuration file:
+ * ## Configurable parameters: ##
*
- * {@example ../../examples/resources/appender_console.properties 18}
+ * - **target** - the target stream: "stdout" or "stderr"
*
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/console.html
Appender documentation
*/
-class LoggerAppenderConsole extends LoggerAppender {
+ class LoggerAppenderConsole extends LoggerAppender {
+ /** The standard otuput stream. */
const STDOUT = 'php://stdout';
+
+ /** The standard error stream.*/
const STDERR = 'php://stderr';
- /**
- * Can be 'php://stdout' or 'php://stderr'. But it's better to use
keywords <b>STDOUT</b> and <b>STDERR</b> (case insensitive).
- * Default is STDOUT
- * @var string
- */
+ /** The 'target' parameter. */
protected $target = self::STDOUT;
/**
- * @var mixed the resource used to open stdout/stderr
+ * Stream resource for the target stream.
+ * @var resource
*/
protected $fp = null;
- /**
- * Set console target.
- * @param mixed $value a constant or a string
- */
- public function setTarget($value) {
- $v = trim($value);
- if ($v == self::STDOUT || strtoupper($v) == 'STDOUT') {
- $this->target = self::STDOUT;
- } elseif ($v == self::STDERR || strtoupper($v) == 'STDERR') {
- $this->target = self::STDERR;
- } else {
- $value = var_export($value);
- $this->warn("Invalid value given for 'target' property:
[$value]. Property not set.");
- }
- }
-
- public function getTarget() {
- return $this->target;
- }
-
public function activateOptions() {
$this->fp = fopen($this->target, 'w');
if(is_resource($this->fp) && $this->layout !== null) {
@@ -86,6 +60,7 @@ class LoggerAppenderConsole extends Logg
$this->closed = (bool)is_resource($this->fp) === false;
}
+
public function close() {
if($this->closed != true) {
if (is_resource($this->fp) && $this->layout !== null) {
@@ -101,5 +76,28 @@ class LoggerAppenderConsole extends Logg
fwrite($this->fp, $this->layout->format($event));
}
}
+
+ /**
+ * Sets the 'target' parameter.
+ * @param string $target
+ */
+ public function setTarget($target) {
+ $v = trim($target);
+ if ($v == self::STDOUT || strtoupper($v) == 'STDOUT') {
+ $this->target = self::STDOUT;
+ } elseif ($v == self::STDERR || strtoupper($v) == 'STDERR') {
+ $this->target = self::STDERR;
+ } else {
+ $target = var_export($target);
+ $this->warn("Invalid value given for 'target' property:
[$target]. Property not set.");
+ }
+ }
+
+ /**
+ * Returns the value of the 'target' parameter.
+ * @return string
+ */
+ public function getTarget() {
+ return $this->target;
+ }
}
-
Modified:
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderDailyFile.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderDailyFile.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderDailyFile.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderDailyFile.php
Sun May 13 09:25:14 2012
@@ -14,8 +14,6 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
@@ -27,53 +25,30 @@
*
* This appender uses a layout.
*
- * Configurable parameters for this appender are:
- * - datePattern - The date format for the file name. Should be set before
- * $file. Default value: "Ymd".
- * - file - The path to the target log file. The filename should
- * contain a '%s' which will be substituted by the date.
- * - append - Sets if the appender should append to the end of the
- * file or overwrite content ("true" or "false"). Default
- * value: true.
+ * ##Configurable parameters:##
*
- * An example php file:
+ * - **datePattern** - Format for the date in the file path, follows formatting
+ * rules used by the PHP date() function. Default value: "Ymd".
+ * - **file** - Path to the target file. Should contain a %s which gets
+ * substituted by the date.
+ * - **append** - If set to true, the appender will append to the file,
+ * otherwise the file contents will be overwritten. Defaults to true.
*
- * {@example ../../examples/php/appender_dailyfile.php 19}
- *
- * An example configuration file:
- *
- * {@example ../../examples/resources/appender_dailyfile.properties 18}
- *
- * The above will create a file like: daily_20090908.log
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/daily-file.html
Appender documentation
*/
class LoggerAppenderDailyFile extends LoggerAppenderFile {
/**
- * Format date.
- * It follows the {@link PHP_MANUAL#date()} formatting rules and
<b>should always be set before {@link $file} param</b>.
+ * The 'datePattern' parameter.
+ * Determines how date will be formatted in file name.
* @var string
*/
protected $datePattern = "Ymd";
- /**
- * Sets date format for the file name.
- * @param string $datePattern a regular date() string format
- */
- public function setDatePattern($datePattern) {
- $this->setString('datePattern', $datePattern);
- }
-
- /**
- * @return string returns date format for the filename
- */
- public function getDatePattern() {
- return $this->datePattern;
- }
-
/**
* Similar to parent method, but but replaces "%s" in the file name
with
* the current date in format specified by the 'datePattern' parameter.
@@ -107,4 +82,20 @@ class LoggerAppenderDailyFile extends Lo
$this->closed = true;
}
}
+
+ /**
+ * Sets the 'datePattern' parameter.
+ * @param string $datePattern
+ */
+ public function setDatePattern($datePattern) {
+ $this->setString('datePattern', $datePattern);
+ }
+
+ /**
+ * Returns the 'datePattern' parameter.
+ * @return string
+ */
+ public function getDatePattern() {
+ return $this->datePattern;
+ }
}
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderEcho.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderEcho.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderEcho.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderEcho.php Sun May
13 09:25:14 2012
@@ -14,34 +14,29 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * LoggerAppenderEcho uses {@link PHP_MANUAL#echo echo} function to output
events.
- *
- * <p>This appender requires a layout.</p>
+ * LoggerAppenderEcho uses the PHP echo() function to output events.
*
- * An example php file:
+ * This appender uses a layout.
*
- * {@example ../../examples/php/appender_echo.php 19}
+ * ## Configurable parameters: ##
*
- * An example configuration file:
- *
- * {@example ../../examples/resources/appender_echo.properties 18}
- *
- * The above example would print the following:
- * <pre>
- * Tue Sep 8 22:44:55 2009,812 [6783] DEBUG appender_echo - Hello World!
- * </pre>
+ * - **htmlLineBreaks** - If set to true, a <br /> element will be inserted
+ * before each line break in the logged message. Default is false.
*
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/echo.html Appender
documentation
*/
class LoggerAppenderEcho extends LoggerAppender {
- /** boolean used internally to mark first append */
+ /**
+ * Used to mark first append. Set to false after first append.
+ * @var boolean
+ */
protected $firstAppend = true;
/**
@@ -74,10 +69,18 @@ class LoggerAppenderEcho extends LoggerA
}
}
+ /**
+ * Sets the 'htmlLineBreaks' parameter.
+ * @param boolean $value
+ */
public function setHtmlLineBreaks($value) {
$this->setBoolean('htmlLineBreaks', $value);
}
-
+
+ /**
+ * Returns the 'htmlLineBreaks' parameter.
+ * @returns boolean
+ */
public function getHtmlLineBreaks() {
return $this->htmlLineBreaks;
}
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFile.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFile.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFile.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFile.php Sun May
13 09:25:14 2012
@@ -14,31 +14,25 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * FileAppender appends log events to a file.
+ * LoggerAppenderFile appends log events to a file.
*
* This appender uses a layout.
*
- * Configurable parameters for this appender are:
- * - file - The target file to write to
- * - filename - The target file to write to (deprecated, use "file" instead)
- * - append - Sets if the appender should append to the end of the file or
overwrite content ("true" or "false")
- *
- * An example php file:
+ * ## Configurable parameters: ##
*
- * {@example ../../examples/php/appender_file.php 19}
+ * - **file** - Path to the target file. Relative paths are resolved based on
+ * the working directory.
+ * - **append** - If set to true, the appender will append to the file,
+ * otherwise the file contents will be overwritten.
*
- * An example configuration file:
- *
- * {@example ../../examples/resources/appender_file.properties 18}
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/file.html Appender
documentation
*/
class LoggerAppenderFile extends LoggerAppender {
@@ -116,7 +110,7 @@ class LoggerAppenderFile extends LoggerA
}
/**
- * Sets the file where the log output will go.
+ * Sets the 'file' parameter.
* @param string $file
*/
public function setFile($file) {
@@ -124,6 +118,7 @@ class LoggerAppenderFile extends LoggerA
}
/**
+ * Returns the 'file' parameter.
* @return string
*/
public function getFile() {
@@ -131,18 +126,23 @@ class LoggerAppenderFile extends LoggerA
}
/**
+ * Returns the 'append' parameter.
* @return boolean
*/
public function getAppend() {
return $this->append;
}
+ /**
+ * Sets the 'append' parameter.
+ * @param boolean $append
+ */
public function setAppend($append) {
$this->setBoolean('append', $append);
}
/**
- * Sets the file where the log output will go.
+ * Sets the 'file' parmeter. Left for legacy reasons.
* @param string $fileName
* @deprecated Use setFile() instead.
*/
@@ -151,12 +151,11 @@ class LoggerAppenderFile extends LoggerA
}
/**
+ * Returns the 'file' parmeter. Left for legacy reasons.
* @return string
* @deprecated Use getFile() instead.
*/
public function getFileName() {
return $this->getFile();
}
-
-
}
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFirephp.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFirephp.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFirephp.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderFirephp.php Sun
May 13 09:25:14 2012
@@ -14,8 +14,6 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
@@ -23,26 +21,18 @@
*
* This appender requires the FirePHP server library version 1.0 or later.
*
- * Configurable parameters of this appender are:
- * - target - (string) The target to which messages will be sent. Possible
options are
+ * ## Configurable parameters: ##
+ *
+ * - **target** - (string) The target to which messages will be sent. Possible
options are
* 'page' (default), 'request', 'package' and 'controller'. For
more details,
* see FirePHP documentation.
*
* This class was originally contributed by Bruce Ingalls
(Bruce.Ingalls-at-gmail-dot-com).
*
- * An example php file:
- *
- * {@example ../../examples/php/appender_firephp.php 19}
- *
- * An example configuration file:
- *
- * {@example ../../examples/resources/appender_firephp.xml 18}
- *
- * @link https://github.com/firephp/firephp FirePHP 1.0 homepage.
- * @link
http://sourcemint.com/github.com/firephp/firephp/1:1.0.0b1rc6/-docs/Welcome
- * FirePHP documentation.
- * @link
http://sourcemint.com/github.com/firephp/firephp/1:1.0.0b1rc6/-docs/Configuration/Constants
- * FirePHP constants documentation.
+ * @link https://github.com/firephp/firephp FirePHP homepage.
+ * @link
http://sourcemint.com/github.com/firephp/firephp/1:1.0.0b1rc6/-docs/Welcome
FirePHP documentation.
+ * @link
http://sourcemint.com/github.com/firephp/firephp/1:1.0.0b1rc6/-docs/Configuration/Constants
FirePHP constants documentation.
+ * @link http://logging.apache.org/log4php/docs/appenders/firephp.html
Appender documentation
*
* @version $Revision$
* @package log4php
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMail.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMail.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMail.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMail.php Sun May
13 09:25:14 2012
@@ -14,61 +14,71 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Appends log events to mail using php function {@link PHP_MANUAL#mail}.
- *
- * The appender sends all log events at once after the request has been
- * finsished and the appender is beeing closed.
+ * LoggerAppenderMail appends log events via email.
*
- * Configurable parameters for this appender:
+ * This appender does not send individual emails for each logging requests but
+ * will collect them in a buffer and send them all in a single email once the
+ * appender is closed (i.e. when the script exists). Because of this, it may
+ * not appropriate for long running scripts, in which case
+ * LoggerAppenderMailEvent might be a better choice.
*
- * - layout - Sets the layout class for this appender (required)
- * - to - Sets the recipient of the mail (required)
- * - from - Sets the sender of the mail (optional)
- * - subject - Sets the subject of the mail (optional)
+ * This appender uses a layout.
*
- * An example:
+ * ## Configurable parameters: ##
*
- * {@example ../../examples/php/appender_mail.php 19}
+ * - **to** - Email address(es) to which the log will be sent. Multiple email
+ * addresses may be specified by separating them with a comma.
+ * - **from** - Email address which will be used in the From field.
+ * - **subject** - Subject of the email message.
*
- * {@example ../../examples/resources/appender_mail.properties 18}
- *
- * The above will output something like:
- * <pre>
- * Date: Tue, 8 Sep 2009 21:51:04 +0200 (CEST)
- * From: [email protected]
- * To: root@localhost
- * Subject: Log4php test
- *
- * Tue Sep 8 21:51:04 2009,120 [5485] FATAL root - Some critical message!
- * Tue Sep 8 21:51:06 2009,120 [5485] FATAL root - Some more critical
message!
- * </pre>
-
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/mail.html Appender
documentation
*/
class LoggerAppenderMail extends LoggerAppender {
- /** @var string 'from' field */
+ /**
+ * Email address to put in From field of the email.
+ * @var string
+ */
protected $from = null;
- /** @var string 'subject' field */
+ /**
+ * The subject of the email.
+ * @var string
+ */
protected $subject = 'Log4php Report';
- /** @var string 'to' field */
+ /**
+ * One or more comma separated email addresses to which to send the
email.
+ * @var string
+ */
protected $to = null;
- /** @var indiciates if this appender should run in dry mode */
+ /**
+ * Indiciates whether this appender should run in dry mode.
+ * @deprecated
+ * @var boolean
+ */
protected $dry = false;
- /** @var string used to create mail body */
+ /**
+ * Buffer which holds the email contents before it is sent.
+ * @var string
+ */
protected $body = '';
+ public function append(LoggerLoggingEvent $event) {
+ if($this->layout !== null) {
+ $this->body .= $this->layout->format($event);
+ }
+ }
+
public function close() {
if($this->closed != true) {
$from = $this->from;
@@ -89,25 +99,38 @@ class LoggerAppenderMail extends LoggerA
}
}
+ /** Sets the 'subject' parameter. */
public function setSubject($subject) {
$this->setString('subject', $subject);
}
+ /** Returns the 'subject' parameter. */
+ public function getSubject() {
+ return $this->subject;
+ }
+
+ /** Sets the 'to' parameter. */
public function setTo($to) {
$this->setString('to', $to);
}
+
+ /** Returns the 'to' parameter. */
+ public function getTo() {
+ return $this->to;
+ }
+ /** Sets the 'from' parameter. */
public function setFrom($from) {
$this->setString('from', $from);
}
+
+ /** Returns the 'from' parameter. */
+ public function getFrom() {
+ return $this->from;
+ }
+ /** Enables or disables dry mode. */
public function setDry($dry) {
$this->setBoolean('dry', $dry);
}
-
- public function append(LoggerLoggingEvent $event) {
- if($this->layout !== null) {
- $this->body .= $this->layout->format($event);
- }
- }
}
Modified:
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMailEvent.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMailEvent.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMailEvent.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMailEvent.php
Sun May 13 09:25:14 2012
@@ -14,71 +14,69 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Log every events as a separate email.
+ * LoggerAppenderMailEvent appends individual log events via email.
*
- * Configurable parameters for this appender are:
+ * This appender is similar to LoggerAppenderMail, except that it sends each
+ * each log event in an individual email message at the time when it occurs.
*
- * - layout - Sets the layout class for this appender (required)
- * - to - Sets the recipient of the mail (required)
- * - from - Sets the sender of the mail (optional)
- * - subject - Sets the subject of the mail (optional)
- * - smtpHost - Sets the mail server (optional, default is
ini_get('SMTP'))
- * - port - Sets the port of the mail server (optional, default
is 25)
- *
- * An example:
+ * This appender uses a layout.
*
- * {@example ../../examples/php/appender_mailevent.php 19}
- *
- * {@example ../../examples/resources/appender_mailevent.properties 18}
- *
+ * ## Configurable parameters: ##
*
- * The above will output something like:
- * <pre>
- * Date: Tue, 8 Sep 2009 21:51:04 +0200 (CEST)
- * From: [email protected]
- * To: root@localhost
- * Subject: Log4php test
- *
- * Tue Sep 8 21:51:04 2009,120 [5485] FATAL root - Some critical message!
- * </pre>
+ * - **to** - Email address(es) to which the log will be sent. Multiple email
+ * addresses may be specified by separating them with a comma.
+ * - **from** - Email address which will be used in the From field.
+ * - **subject** - Subject of the email message.
+ * - **smtpHost** - Used to override the SMTP server. Only works on Windows.
+ * - **port** - Used to override the default SMTP server port. Only works on
+ * Windows.
*
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/mail-event.html
Appender documentation
*/
class LoggerAppenderMailEvent extends LoggerAppender {
- /** 'from' field (defaults to 'sendmail_from' from php.ini on win32).
+ /**
+ * Email address to put in From field of the email.
* @var string
*/
protected $from;
- /** Mailserver port (win32 only).
+ /**
+ * Mail server port (widnows only).
* @var integer
*/
protected $port = 25;
- /** Mailserver hostname (win32 only).
+ /**
+ * Mail server hostname (windows only).
* @var string
*/
- protected $smtpHost = null;
+ protected $smtpHost;
- /**
- * @var string 'subject' field
+ /**
+ * The subject of the email.
+ * @var string
*/
- protected $subject = '';
+ protected $subject = 'Log4php Report';
/**
- * @var string 'to' field
+ * One or more comma separated email addresses to which to send the
email.
+ * @var string
*/
protected $to = null;
- /** @var indiciates if this appender should run in dry mode */
+ /**
+ * Indiciates whether this appender should run in dry mode.
+ * @deprecated
+ * @var boolean
+ */
protected $dry = false;
public function activateOptions() {
@@ -97,55 +95,89 @@ class LoggerAppenderMailEvent extends Lo
$this->closed = false;
}
+
+ public function append(LoggerLoggingEvent $event) {
+ $smtpHost = $this->smtpHost;
+ $prevSmtpHost = ini_get('SMTP');
+ if(!empty($smtpHost)) {
+ ini_set('SMTP', $smtpHost);
+ }
+
+ $smtpPort = $this->port;
+ $prevSmtpPort= ini_get('smtp_port');
+ if($smtpPort > 0 and $smtpPort < 65535) {
+ ini_set('smtp_port', $smtpPort);
+ }
+
+ // On unix only sendmail_path, which is PHP_INI_SYSTEM i.e. not
changeable here, is used.
+
+ $addHeader = empty($this->from) ? '' : "From:
{$this->from}\r\n";
+
+ if(!$this->dry) {
+ $result = mail($this->to, $this->subject,
$this->layout->getHeader() . $this->layout->format($event) .
$this->layout->getFooter($event), $addHeader);
+ } else {
+ echo "DRY MODE OF MAIL APP.: Send mail to:
".$this->to." with additional headers '".trim($addHeader)."' and content:
".$this->layout->format($event);
+ }
+
+ ini_set('SMTP', $prevSmtpHost);
+ ini_set('smtp_port', $prevSmtpPort);
+ }
+ /** Sets the 'from' parameter. */
public function setFrom($from) {
$this->setString('from', $from);
}
+ /** Returns the 'from' parameter. */
+ public function getFrom() {
+ return $this->from;
+ }
+
+ /** Sets the 'port' parameter. */
public function setPort($port) {
$this->setPositiveInteger('port', $port);
}
+ /** Returns the 'port' parameter. */
+ public function getPort() {
+ return $this->port;
+ }
+
+ /** Sets the 'smtpHost' parameter. */
public function setSmtpHost($smtpHost) {
$this->setString('smtpHost', $smtpHost);
}
+ /** Returns the 'smtpHost' parameter. */
+ public function getSmtpHost() {
+ return $this->smtpHost;
+ }
+
+ /** Sets the 'subject' parameter. */
public function setSubject($subject) {
$this->setString('subject', $subject);
}
+ /** Returns the 'subject' parameter. */
+ public function getSubject() {
+ return $this->subject;
+ }
+
+ /** Sets the 'to' parameter. */
public function setTo($to) {
$this->setString('to', $to);
}
+
+ /** Returns the 'to' parameter. */
+ public function getTo() {
+ return $this->to;
+ }
+ /** Enables or disables dry mode. */
public function setDry($dry) {
$this->setBoolean('dry', $dry);
}
-
- public function append(LoggerLoggingEvent $event) {
- $smtpHost = $this->smtpHost;
- $prevSmtpHost = ini_get('SMTP');
- if(!empty($smtpHost)) {
- ini_set('SMTP', $smtpHost);
- }
- $smtpPort = $this->port;
- $prevSmtpPort= ini_get('smtp_port');
- if($smtpPort > 0 and $smtpPort < 65535) {
- ini_set('smtp_port', $smtpPort);
- }
-
- // On unix only sendmail_path, which is PHP_INI_SYSTEM i.e. not
changeable here, is used.
+
- $addHeader = empty($this->from) ? '' : "From:
{$this->from}\r\n";
-
- if(!$this->dry) {
- $result = mail($this->to, $this->subject,
$this->layout->getHeader() . $this->layout->format($event) .
$this->layout->getFooter($event), $addHeader);
- } else {
- echo "DRY MODE OF MAIL APP.: Send mail to:
".$this->to." with additional headers '".trim($addHeader)."' and content:
".$this->layout->format($event);
- }
-
- ini_set('SMTP', $prevSmtpHost);
- ini_set('smtp_port', $prevSmtpPort);
- }
}
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMongoDB.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMongoDB.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMongoDB.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderMongoDB.php Sun
May 13 09:25:14 2012
@@ -14,8 +14,6 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
@@ -23,6 +21,9 @@
*
* This class was originally contributed by Vladimir Gorej.
*
+ * ## Configurable parameters: ##
+ *
+ *
* @link http://github.com/log4mongo/log4mongo-php Vladimir Gorej's original
submission.
* @link http://www.mongodb.org/ MongoDB website.
*
@@ -30,6 +31,8 @@
* @package log4php
* @subpackage appenders
* @since 2.1
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/mongodb.html
Appender documentation
*/
class LoggerAppenderMongoDB extends LoggerAppender {
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderNull.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderNull.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderNull.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderNull.php Sun May
13 09:25:14 2012
@@ -14,8 +14,6 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
@@ -23,15 +21,11 @@
*
* This appender has no configurable parameters.
*
- * An example:
- *
- * {@example ../../examples/php/appender_null.php 19}
- *
- * {@example ../../examples/resources/appender_null.properties 18}
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/null.html Appender
documentation
*/
class LoggerAppenderNull extends LoggerAppender {
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPDO.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPDO.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPDO.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPDO.php Sun May
13 09:25:14 2012
@@ -14,19 +14,17 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Appends log events to a db table using PDO.
+ * LoggerAppenderPDO appender logs to a database using the PHP's PDO extension.
*
- * Configurable parameters of this appender are:
+ * ## Configurable parameters: ##
*
- * - dsn - The DSN string for this connection
- * - user - The user of this database connection
- * - password - The password of this database connection
- * - table - Name of the database table into which log entries will
be inserted (default: log4php_log)
+ * - dsn - The Data Source Name (DSN) used to connect to the
database.
+ * - user - Username used to connect to the database.
+ * - password - Password used to connect to the database.
+ * - table - Name of the table to which log entries are be inserted.
* - insertSQL - Sets the insert statement for a logging event. Defaults
* to the correct one - change only if you are sure what
you are doing.
* - insertPattern - The conversion pattern to use in conjuction with insert
@@ -34,18 +32,12 @@
* conversion patterns as there are question marks in the
* insertSQL.
*
- * If $sql is set then $table and $sql are used, else $table, $insertSQL and
$insertPattern.
- *
- * An example:
- *
- * {@example ../../examples/php/appender_pdo.php 19}
- *
- * {@example ../../examples/resources/appender_pdo.properties 18}
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
* @since 2.0
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/pdo.html Appender
documentation
*/
class LoggerAppenderPDO extends LoggerAppender {
@@ -112,7 +104,7 @@ class LoggerAppenderPDO extends LoggerAp
/** This appender does not require a layout. */
protected $requiresLayout = false;
-
+
// ******************************************
// *** Appender methods ***
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPhp.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPhp.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPhp.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderPhp.php Sun May
13 09:25:14 2012
@@ -14,12 +14,11 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Log events using php {@link PHP_MANUAL#trigger_error} function and a {@link
LoggerLayoutSimple} default layout.
+ * LoggerAppenderPhp logs events by creating a PHP user-level message using
+ * the PHP's trigger_error()function.
*
* This appender has no configurable parameters.
*
@@ -29,28 +28,22 @@
* - <b>WARN <= level < ERROR</b> mapped to E_USER_WARNING
* - <b>level >= ERROR</b> mapped to E_USER_ERROR
*
- * An example:
- *
- * {@example ../../examples/php/appender_php.php 19}
- *
- * {@example ../../examples/resources/appender_php.properties 18}
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/php.html Appender
documentation
*/
class LoggerAppenderPhp extends LoggerAppender {
public function append(LoggerLoggingEvent $event) {
- if($this->layout !== null) {
- $level = $event->getLevel();
-
if($level->isGreaterOrEqual(LoggerLevel::getLevelError())) {
- trigger_error($this->layout->format($event),
E_USER_ERROR);
- } else if
($level->isGreaterOrEqual(LoggerLevel::getLevelWarn())) {
- trigger_error($this->layout->format($event),
E_USER_WARNING);
- } else {
- trigger_error($this->layout->format($event),
E_USER_NOTICE);
- }
+ $level = $event->getLevel();
+ if($level->isGreaterOrEqual(LoggerLevel::getLevelError())) {
+ trigger_error($this->layout->format($event),
E_USER_ERROR);
+ } else if
($level->isGreaterOrEqual(LoggerLevel::getLevelWarn())) {
+ trigger_error($this->layout->format($event),
E_USER_WARNING);
+ } else {
+ trigger_error($this->layout->format($event),
E_USER_NOTICE);
}
}
}
Modified:
logging/log4php/trunk/src/main/php/appenders/LoggerAppenderRollingFile.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderRollingFile.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderRollingFile.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderRollingFile.php
Sun May 13 09:25:14 2012
@@ -19,33 +19,28 @@
*/
/**
- * LoggerAppenderRollingFile extends LoggerAppenderFile to backup the log
files
- * when they reach a certain size.
+ * LoggerAppenderRollingFile writes logging events to a specified file. The
+ * file is rolled over after a specified size has been reached.
*
* This appender uses a layout.
*
- * Parameters are:
- * - file - The target file to write to
- * - filename - The target file to write to (deprecated, use "file"
instead).
- * - append - Sets if the appender should append to the end of the
file or overwrite content ("true" or "false")
- * - maxBackupIndex - Set the maximum number of backup files to keep around
(int)
- * - 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
- * - maximumFileSize - Alias to maxFileSize (deprecated, use "maxFileSize"
instead)
- * - compress - Compress the rollover file ("true" or "false")
- *
- * <p>Contributors: Sergio Strampelli.</p>
- *
- * An example:
- *
- * {@example ../../examples/php/appender_socket.php 19}
- *
- * {@example ../../examples/resources/appender_socket.properties 18}
+ * ## Configurable parameters: ##
+ *
+ * - **file** - Path to the target file.
+ * - **append** - If set to true, the appender will append to the file,
+ * otherwise the file contents will be overwritten.
+ * - **maxBackupIndex** - Maximum number of backup files to keep. Default is 1.
+ * - **maxFileSize** - Maximum allowed file size (in bytes) before rolling
+ * over. Suffixes "KB", "MB" and "GB" are allowed. 10KB = 10240 bytes, etc.
+ * Default is 10M.
+ * - **compress** - If set to true, rolled-over files will be compressed.
+ * Requires the zlib extension.
*
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/rolling-file.html
Appender documentation
*/
class LoggerAppenderRollingFile extends LoggerAppenderFile {
@@ -87,12 +82,9 @@ class LoggerAppenderRollingFile extends
private $expandedFileName = null;
/**
- * <p>The <var>Compress</var> option determindes the compression with
zlib.
- * If set to true, then the rollover file is compressed and saved with
the
- * file-extension .gz.
- * </p>
- *
- * @var boolean Compress the rollover file
+ * The <var>compress</var> parameter determindes the compression with
zlib.
+ * If set to true, the rollover files are compressed and saved with the
.gz extension.
+ * @var boolean
*/
protected $compress = false;
@@ -194,34 +186,6 @@ class LoggerAppenderRollingFile extends
$this->setPositiveInteger('maxBackupIndex', $maxBackups);
}
- /**
- * Set the maximum size that the output file is allowed to reach
- * before being rolled over to backup files.
- *
- * @param mixed $maxFileSize
- * @see setMaxFileSize()
- * @deprecated
- */
- public function setMaximumFileSize($maxFileSize) {
- return $this->setMaxFileSize($maxFileSize);
- }
-
- /**
- * Set the maximum size that the output file is allowed to reach
- * before being rolled over to backup files.
- * <p>In configuration files, the <b>maxFileSize</b> 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.
- *
- * @param mixed $value
- * @return the actual file size set
- */
- public function setMaxFileSize($value) {
- $this->setFileSize('maxFileSize', $value);
- }
public function append(LoggerLoggingEvent $event) {
if($this->fp and $this->layout !== null) {
@@ -253,15 +217,45 @@ class LoggerAppenderRollingFile extends
}
/**
- * @return Returns the maximum number of backup files to keep around.
+ * Returns the 'maxBackupIndex' parameter.
+ * @return integer
*/
public function getMaxBackupIndex() {
return $this->maxBackupIndex;
}
/**
- * @return Returns the maximum size that the output file is allowed to
reach
+ * Set the maximum size that the output file is allowed to reach
+ * before being rolled over to backup files.
+ * <p>In configuration files, the <b>maxFileSize</b> 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.
+ *
+ * @param mixed $value
+ * @return the actual file size set
+ */
+ public function setMaxFileSize($value) {
+ $this->setFileSize('maxFileSize', $value);
+ }
+
+ /**
+ * Set the maximum size that the output file is allowed to reach
* before being rolled over to backup files.
+ *
+ * @param mixed $maxFileSize
+ * @see setMaxFileSize()
+ * @deprecated
+ */
+ public function setMaximumFileSize($maxFileSize) {
+ return $this->setMaxFileSize($maxFileSize);
+ }
+
+ /**
+ * Returns the 'maxFileSize' parameter.
+ * @return integer
*/
public function getMaxFileSize() {
return $this->maxFileSize;
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSocket.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSocket.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSocket.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSocket.php Sun
May 13 09:25:14 2012
@@ -14,25 +14,25 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Appends events to a network socket.
+ * LoggerAppenderSocket appends to a network socket.
*
- * This appender can be configured by changing the following attributes:
+ * ## Configurable parameters: ##
*
- * - remoteHost - Target remote host.
- * - port - Target port (optional, defaults to 4446).
- * - timeout - Connection timeout in seconds (optional, defaults to
- * 'default_socket_timeout' from php.ini)
+ * - **remoteHost** - Target remote host.
+ * - **port** - Target port (optional, defaults to 4446).
+ * - **timeout** - Connection timeout in seconds (optional, defaults to
+ * 'default_socket_timeout' from php.ini)
*
* The socket will by default be opened in blocking mode.
*
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/socket.html Appender
documentation
*/
class LoggerAppenderSocket extends LoggerAppender {
Modified: logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSyslog.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSyslog.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSyslog.php
(original)
+++ logging/log4php/trunk/src/main/php/appenders/LoggerAppenderSyslog.php Sun
May 13 09:25:14 2012
@@ -14,46 +14,48 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- *
- * @package log4php
*/
/**
- * Log events to a system log using the {@link PHP_MANUAL#syslog} function.
+ * Log events to a system log using the PHP syslog() function.
*
* This appenders requires a layout.
*
- * Configurable parameters:
+ * ## Configurable parameters: ##
*
- * - ident - The ident of the syslog message.
- * - priority - The priority for the syslog message (used when
overriding priority).
- * - facility - The facility for the syslog message
- * - overridePriority - If set to true, the message priority will always use
- * the value defined in {@link $priority}, otherwise the
- * priority will be determined by the message's log
level.
- * - option - The option value for the syslog message.
+ * - **ident** - The ident of the syslog message.
+ * - **priority** - The priority for the syslog message (used when overriding
+ * priority).
+ * - **facility** - The facility for the syslog message
+ * - **overridePriority** - If set to true, the message priority will always
+ * use the value defined in {@link $priority}, otherwise the priority will
+ * be determined by the message's log level.
+ * - **option** - The option value for the syslog message.
*
* Recognised syslog options are:
- * - CONS - if there is an error while sending data to the system
logger, write directly to the system console
- * - NDELAY - open the connection to the logger immediately
- * - ODELAY - delay opening the connection until the first message is
logged (default)
- * - PERROR - print log message also to standard error
- * - PID - include PID with each message
+ *
+ * - CONS - if there is an error while sending data to the system
logger, write directly to the system console
+ * - NDELAY - open the connection to the logger immediately
+ * - ODELAY - delay opening the connection until the first message is logged
(default)
+ * - PERROR - print log message also to standard error
+ * - PID - include PID with each message
*
* Multiple options can be set by delimiting them with a pipe character,
* e.g.: "CONS|PID|PERROR".
*
* Recognised syslog priorities are:
- * - EMERG
- * - ALERT
- * - CRIT
- * - ERR
- * - WARNING
- * - NOTICE
- * - INFO
- * - DEBUG
+ *
+ * - EMERG
+ * - ALERT
+ * - CRIT
+ * - ERR
+ * - WARNING
+ * - NOTICE
+ * - INFO
+ * - DEBUG
*
* Levels are mapped as follows:
+ *
* - <b>FATAL</b> to LOG_ALERT
* - <b>ERROR</b> to LOG_ERR
* - <b>WARN</b> to LOG_WARNING
@@ -61,15 +63,11 @@
* - <b>DEBUG</b> to LOG_DEBUG
* - <b>TRACE</b> to LOG_DEBUG
*
- * An example:
- *
- * {@example ../../examples/php/appender_syslog.php 19}
- *
- * {@example ../../examples/resources/appender_syslog.properties 18}
- *
* @version $Revision$
* @package log4php
* @subpackage appenders
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version
2.0
+ * @link http://logging.apache.org/log4php/docs/appenders/syslog.html Appender
documentation
*/
class LoggerAppenderSyslog extends LoggerAppender {
@@ -166,7 +164,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Sets the {@link $option}.
+ * Sets the 'option' parameter.
*
* @param string $option
*/
@@ -175,7 +173,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Returns the {@link $ident}.
+ * Returns the 'ident' parameter.
*
* @return string $ident
*/
@@ -184,7 +182,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Returns the {@link $priority}.
+ * Returns the 'priority' parameter.
*
* @return string
*/
@@ -193,7 +191,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Returns the {@link $facility}.
+ * Returns the 'facility' parameter.
*
* @return string
*/
@@ -202,7 +200,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Returns the {@link $overridePriority}.
+ * Returns the 'overridePriority' parameter.
*
* @return string
*/
@@ -211,7 +209,7 @@ class LoggerAppenderSyslog extends Logge
}
/**
- * Returns the {@link $option}.
+ * Returns the 'option' parameter.
*
* @return string
*/
Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml
(original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml Sun May
13 09:25:14 2012
@@ -86,6 +86,13 @@
<td>1</td>
<td>Maximum number of
backup files to keep.</td>
</tr>
+ <tr>
+ <td>compress</td>
+ <td>boolean</td>
+ <td>No</td>
+ <td>false</td>
+ <td>If set to true, the
rollover files are compressed and saved with the .gz extension.</td>
+ </tr>
</tbody>
</table>
Modified:
logging/log4php/trunk/src/test/php/appenders/LoggerAppenderMailEventTest.php
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/test/php/appenders/LoggerAppenderMailEventTest.php?rev=1337820&r1=1337819&r2=1337820&view=diff
==============================================================================
---
logging/log4php/trunk/src/test/php/appenders/LoggerAppenderMailEventTest.php
(original)
+++
logging/log4php/trunk/src/test/php/appenders/LoggerAppenderMailEventTest.php
Sun May 13 09:25:14 2012
@@ -34,7 +34,7 @@ class LoggerAppenderMailEventTest extend
}
public function testMail() {
- $appender = new LoggerAppenderMailEvent("myname ");
+ $appender = new LoggerAppenderMailEvent("myname");
$layout = new LoggerLayoutSimple();
$appender->setLayout($layout);
