php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

seaslog : fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 15:08:50 +00:00
parent ed0559b36f
commit 60f4ad4299
35 changed files with 406 additions and 474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
reference/seaslog/book.xml
View File

@@ -1,38 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.seaslog" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.seaslog">
<?phpdoc extension-membership="pecl" ?>
<title>Seaslog</title>
<titleabbrev>Seaslog</titleabbrev>
<preface xml:id="intro.seaslog">
&reftitle.intro;
<para>
<simpara>
The <acronym>Seaslog</acronym> is an effective,fast,stable log extension for PHP.
</para>
<para>
</simpara>
<simpara>
The log journal，which is usually the operate record of the system，
software and the application record.
software and the application record.
Through the analysis of the log，it can facilitate users to understand the operation of the system，
software and the application situation.
software and the application situation.
If your application log is rich enough,
it can also analyze the previous use’s operation behavior,type,
regional distribution or other more information.
regional distribution or other more information.
The application log also points the multiple levels at the same time,
you can easily get the application analysis of health status,
you can easily get the application analysis of health status,
timely find problems and quick positioning, and solve the problem, remedy the loss.
</para>
<para>
The error_log, syslog function which built in PHP is powerful and excellent performance,
but due to various defects (error_log have no error level, no fixed format, syslog regardless of module,
</simpara>
<simpara>
The error_log, syslog function which built in PHP is powerful and excellent performance,
but due to various defects (error_log have no error level, no fixed format, syslog regardless of module,
and mix with system log ), reducing a lot of flexibility , and can't meet the application requirements.
</para>
<para>
The good news is that there are a number of third-party log class library established
to make up for the defects, such as log4php, plog, monolog (of course,
there are many applications in the project development of the log class).
</para>
</simpara>
<simpara>
The good news is that there are a number of third-party log class library established
to make up for the defects, such as log4php, plog, monolog (of course,
there are many applications in the project development of the log class).
</simpara>
<para>
So is there a log of libraries meet the following requirements：
<simplelist>
@@ -60,9 +59,9 @@
<member>Support for log template customizations</member>
</simplelist>
</para>
<para>
<simpara>
Read More <link xlink:href="&url.seaslog.document;">SeasLog Document</link> at Github.
</para>
</simpara>
</preface>
&reference.seaslog.setup;
@@ -72,7 +71,6 @@
&reference.seaslog.seaslog;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/seaslog/configure.xml
View File

@@ -1,18 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="seaslog.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;seaslog">&url.pecl.package;seaslog</link>
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

23
reference/seaslog/examples.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="seaslog.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.examples">
&reftitle.examples;
<example>
@@ -69,14 +68,14 @@ SeasLog::emergency('Just now, the house next door was completely burnt out! {not
?>
]]>
</programlisting>
<para>
<simpara>
As the default, <emphasis>seaslog.default_template = "%T | %L | %P | %Q | %t | %M"</emphasis>.
That's mean,as the default,log record style is： `{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}`.
</para>
</simpara>
&example.outputs.similar;
<para>
<simpara>
<emphasis>seaslog.appender = 1</emphasis>
</para>
</simpara>
<screen>
<![CDATA[
2014-07-27 08:53:52 | ERROR | 23625 | 599159975a9ff | 1406422432.786 | this is a error test by log
@@ -90,9 +89,9 @@ SeasLog::emergency('Just now, the house next door was completely burnt out! {not
]]>
</screen>
&example.outputs.similar;
<para>
<simpara>
<emphasis>seaslog.appender = 2</emphasis> or <emphasis>seaslog.appender = 3</emphasis>
</para>
</simpara>
<screen>
<![CDATA[
The log style finally formatted such as:
@@ -105,9 +104,9 @@ The log style finally formatted such as:
<example>
<title>Fast count some type of log count value</title>
<para>
<simpara>
<emphasis>SeasLog</emphasis> get count value of `grep -wc` use system pipe and return to PHP (array or int).
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php
@@ -149,9 +148,9 @@ int(1)
<example>
<title>Acquisit some type of log list</title>
<para>
<simpara>
<emphasis>SeasLog</emphasis> get count value of `grep -w` use system pipe and return array to PHP.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php

14
reference/seaslog/functions/seaslog-get-author.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.seaslog-get-author" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.seaslog-get-author">
<refnamediv>
<refname>seaslog_get_author</refname>
<refpurpose>Get SeasLog author.</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>seaslog_get_author</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return SeasLog author as string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -55,7 +54,6 @@ string(29) "Chitao.Gao [ neeke@php.net ]"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/seaslog/functions/seaslog-get-version.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.seaslog-get-version" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.seaslog-get-version">
<refnamediv>
<refname>seaslog_get_version</refname>
<refpurpose>Get SeasLog version.</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>seaslog_get_version</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return SeasLog version (SEASLOG_VERSION) as string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -55,7 +54,6 @@ string(5) "1.8.4"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

148
reference/seaslog/ini.xml
View File

@@ -172,17 +172,17 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch the Record Log Data Store. 1File 2TCP 3UDP (Switch default 1)
</para>
<para>
</simpara>
<simpara>
SeasLog will send log to tcp://remote_host:remote_port or udp://remote_host:remote_port server,
when <emphasis>seaslog.appender</emphasis> configured to <literal>2 (TCP)</literal> or <literal>3 (UDP)</literal>.
</para>
<para>
</simpara>
<simpara>
When <emphasis>SeasLog</emphasis> send log to TCP/UDP，style follow RFC5424.
The <literal>{logInfo}</literal> affected by <emphasis>seaslog.default_template</emphasis>.
</para>
</simpara>
<screen>
<![CDATA[
The log style finally formatted such as:
@@ -199,10 +199,10 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Record Log Retry Count.
Default 0 (Do Not Retry)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.buffer-disabled-in-cli">
@@ -211,16 +211,16 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Disable buffer in cli. 1-Y 0-N(Default)
</para>
<para>
</simpara>
<simpara>
Switch the configure buffer_disabled_in_cli on.
The buffer_disabled_in_cli switch default off.
If switch buffer_disabled_in_cli on, and running in cli,
seaslog.use_buffer setting will be discarded,
Seaslog write to the Data Store IMMEDIATELY.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.buffer-size">
@@ -229,12 +229,12 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Configure the buffer_size with 100.
The buffer_size default 0, it’s meaning don’t use buffer.
If buffer_size &gt; 0,SeasLog will rewritten down into the Data Store
when the prerecorded log in memory count &gt;= this buffer_size,and then refresh the memory poll.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-basepath">
@@ -243,9 +243,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
Default Log Base Path. Defult "/var/log/www".
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-datetime-format">
@@ -254,9 +254,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The DateTime Style. Default "Y-m-d H:i:s".
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.default-logger">
@@ -265,9 +265,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
Default Logger Path. Default "default".
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.disting-by-hour">
@@ -276,14 +276,14 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch use the logger with hour. 1-Y 0-N(Default)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_by_hour = 1</emphasis> Switch use Logger DisTing by hour.
It’s meaning SeasLog will create the file each one hour.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -293,16 +293,16 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch use the logger with folder. 1-Y(Default) 0-N
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_folder = 1</emphasis> Switch use Logger DisTing by folder,
it’s meaning SeasLog will create the file deistic by folder,
and when this configure close SeasLog will create file
use underline connect Logger and Time like default_20180211.log.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -312,14 +312,14 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch use the logger with type. 1-Y 0-N(Default)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.disting_type = 1</emphasis> Switch use Logger DisTing by type,
it’s meaning SeasLog will create the file deistic info\warn\error and the other type.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -329,15 +329,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch ignore SeasLog warning. 1-On(Default) 0-Off
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.ignore_warning = 1</emphasis> Open a warning to ignore SeasLog itself.
When directory permissions or receive server ports are blocked, they are ignored;
when closed, a warning is thrown.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -347,17 +347,17 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Record logger level. Default 8 (All of them).
0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL
</para>
</simpara>
<note>
<para>
<simpara>
Tips: The configuration item has changed since the 1.7.0 version.
Before the 1.7.0 version, the smaller the value, the more logs are taken according to the level:
0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency
Before the 1.7.0 version, Default 0 (All of them).
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -367,10 +367,10 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Log function recall depth.Will affected variable <literal>LineNo</literal> in <literal>%F</literal>.
Default 0
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-host">
@@ -379,9 +379,9 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
If you use Record TCP or UDP, configure this remote ip. Default "127.0.0.1"
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-port">
@@ -390,9 +390,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
If you use Record TCP or UDP, configure this remote port. Default 514
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.remote-timeout">
@@ -401,9 +401,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
If you use Record TCP or UDP, configure this remote timeout. Default 1 second
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.throw-exception">
@@ -412,15 +412,15 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch throw SeasLog exception. 1-On(Default) 0-Off
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.throw_exception = 1</emphasis> Open an exception that throws the SeasLog to throw itself.
When the directory authority or the receive server port is blocked,
throw an exception; do not throw an exception when closed.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -430,9 +430,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Automatic Record final error with default logger. 1-Y(Default) 0-N
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-exception">
@@ -441,9 +441,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Automatic Record exception with default logger. 1-Y 0-N(Default)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-notice">
@@ -452,9 +452,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Automatic Record notice with default logger. 1-Y 0-N(Default)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trace-warning">
@@ -463,9 +463,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Automatic Record warning with default logger. 1-Y 0-N(Default)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.trim-wrap">
@@ -474,9 +474,9 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Trim the \n and \r in log message. 1-On 0-Off(Default)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.seaslog.use-buffer">
@@ -485,17 +485,17 @@ The log style finally formatted such as:
<type>int</type>
</term>
<listitem>
<para>
<simpara>
Switch use the log buffer with memory. 1-Y 0-N(Default)
</para>
</simpara>
<note>
<para>
<simpara>
<emphasis>seaslog.use_buffer = 1</emphasis> Switch the configure use_buffer on.
The use_buffer switch default off.
If switch use_buffer on, SeasLog prerecord the log with memory,
and them would be rewritten down into the Data Store by request shutdown
or php process exit (PHP RSHUTDOWN or PHP MSHUTDOWN).
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -505,24 +505,24 @@ The log style finally formatted such as:
<type>string</type>
</term>
<listitem>
<para>
<simpara>
Default Log template.
Default "%T | %L | %P | %Q | %t | %M".
</para>
</simpara>
<note>
<para>
<simpara>
The following default variables are provided,
which can be used directly in the log template and replaced as a corresponding value
when the log is eventually generated.
</para>
<para>
</simpara>
<simpara>
Default log template is: <literal>seaslog.default_template = "%T | %L | %P | %Q | %t | %M"</literal>,
that's mean,default log style is: <literal>{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}</literal>
</para>
<para>
</simpara>
<simpara>
If you custom log template, such as: <literal>seaslog.default_template = "[%T]:%L %P %Q %t %M"</literal>,
that's will mean,log style was custom as: <literal>[{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo}</literal>
</para>
</simpara>
<table>
<title>Seaslog Default Variable Table</title>
<tgroup cols="2">

12
reference/seaslog/seaslog.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.seaslog" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.seaslog" role="class">
<title>The SeasLog class</title>
<titleabbrev>SeasLog</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ SeasLog intro -->
<section xml:id="seaslog.intro">
&reftitle.intro;
<para>
<simpara>
</para>
</simpara>
</section>
<!-- }}} -->
@@ -31,9 +30,9 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.seaslog')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.seaslog')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -44,7 +43,6 @@
&reference.seaslog.entities.seaslog;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/alert.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.alert" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.alert">
<refnamediv>
<refname>SeasLog::alert</refname>
<refpurpose>Record alert log information</refpurpose>
@@ -18,10 +17,10 @@
<para>
Record alert log information.
<note>
<para>
<simpara>
"ALERT" - Action must be taken immediately.
Immediate attention should be given to relevant personnel for emergency repairs.
</para>
</simpara>
</note>
</para>
@@ -33,29 +32,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -63,9 +62,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -134,7 +133,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/seaslog/seaslog/analyzercount.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.analyzercount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.analyzercount">
<refnamediv>
<refname>SeasLog::analyzerCount</refname>
<refpurpose>Get log count by level, log_path and key_word</refpurpose>
@@ -15,10 +14,10 @@
<methodparam choice="opt"><type>string</type><parameter>log_path</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>key_word</parameter></methodparam>
</methodsynopsis>
<para>
`SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`
<simpara>
`SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`
use system pipe and return to PHP (array or int).
</para>
</simpara>
</refsect1>
@@ -28,25 +27,25 @@
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>
<simpara>
String. The log information level.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>log_path</parameter></term>
<listitem>
<para>
<simpara>
String. The log information path.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key_word</parameter></term>
<listitem>
<para>
<simpara>
String. The search key word for log information.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,10 +53,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
If `level` is SEASLOG_ALL or Empty, return all levels count as `array`.
If `level` is SEASLOG_INFO or the other level, return count as `int`.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -124,7 +123,6 @@ int(29)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

38
reference/seaslog/seaslog/analyzerdetail.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.analyzerdetail" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.analyzerdetail">
<refnamediv>
<refname>SeasLog::analyzerDetail</refname>
<refpurpose>Get log detail by level, log_path, key_word, start, limit, order</refpurpose>
@@ -18,11 +17,11 @@
<methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>order</parameter></methodparam>
</methodsynopsis>
<para>
`SeasLog` get results of
`grep -ai '{level}' | grep -ai '{key_word}' | sed -n '{start},{limit}'p`
<simpara>
`SeasLog` get results of
`grep -ai '{level}' | grep -ai '{key_word}' | sed -n '{start},{limit}'p`
use system pipe and return array to PHP.
</para>
</simpara>
</refsect1>
@@ -32,41 +31,41 @@
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>
<simpara>
String. The log information level.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>log_path</parameter></term>
<listitem>
<para>
<simpara>
String. The log information path.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key_word</parameter></term>
<listitem>
<para>
<simpara>
String. The search key word for log information.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
<simpara>
Int. Default is `1`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
<simpara>
Int. Default is `20`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -90,10 +89,10 @@
<para>
Return results as array.
<note>
<para>
When `start`,`limit` is not NULL and in Windows,
<simpara>
When `start`,`limit` is not NULL and in Windows,
SeasLog will threw exception with message 'Param start and limit don't support Windows'.
</para>
</simpara>
</note>
</para>
</refsect1>
@@ -162,7 +161,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/closeloggerstream.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.closeloggerstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.closeloggerstream">
<refnamediv>
<refname>SeasLog::closeLoggerStream</refname>
<refpurpose>Manually release stream flow from logger</refpurpose>
@@ -14,11 +13,11 @@
<methodparam><type>int</type><parameter>model</parameter></methodparam>
<methodparam><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Manually release stream flow from logger.
SeasLog caches the stream handle opened by the log logger to save the overhead of creating a stream. The handle will be automatically released at the end of the request.
If in CLI mode, the process will also automatically release when it exits. Or you can use the following functions to manually release(manually release function needs to update SeasLog 1.8.6 or updated version).
</para>
</simpara>
</refsect1>
@@ -40,9 +39,9 @@
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
The logger name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on released stream flow success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -92,7 +91,6 @@ bool(true)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/seaslog/seaslog/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.construct">
<refnamediv>
<refname>SeasLog::__construct</refname>
<refpurpose>Description</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>SeasLog::__construct</methodname>
<void />
<void/>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -32,7 +31,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
-->
@@ -62,7 +61,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/seaslog/seaslog/critical.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.critical" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.critical">
<refnamediv>
<refname>SeasLog::critical</refname>
<refpurpose>Record critical log information</refpurpose>
@@ -18,12 +17,12 @@
<para>
Record critical log information.
<note>
<para>
<simpara>
"CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is unavailable.
</para>
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -132,7 +131,6 @@ array(2) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/debug.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.debug" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.debug">
<refnamediv>
<refname>SeasLog::debug</refname>
<refpurpose>Record debug log information</refpurpose>
@@ -18,9 +17,9 @@
<para>
Record debug log information.
<note>
<para>
<simpara>
"DEBUG" - Detailed debug information.Fine-grained information events.
</para>
</simpara>
</note>
</para>
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/destruct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.destruct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.destruct">
<refnamediv>
<refname>SeasLog::__destruct</refname>
<refpurpose>Description</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>SeasLog::__destruct</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
&warn.undocumented.func;
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -57,7 +56,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/emergency.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.emergency" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.emergency">
<refnamediv>
<refname>SeasLog::emergency</refname>
<refpurpose>Record emergency log information</refpurpose>
@@ -18,9 +17,9 @@
<para>
Record emergency log information.
<note>
<para>
<simpara>
"EMERGENCY" - System is unusable.
</para>
</simpara>
</note>
</para>
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/error.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.error">
<refnamediv>
<refname>SeasLog::error</refname>
<refpurpose>Record error log information</refpurpose>
@@ -18,9 +17,9 @@
<para>
Record error log information.
<note>
<para>
<simpara>
"ERROR" - Runtime errors that do not require immediate action but should typically.
</para>
</simpara>
</note>
</para>
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/flushbuffer.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.flushbuffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.flushbuffer">
<refnamediv>
<refname>SeasLog::flushBuffer</refname>
<refpurpose>Flush logs buffer, dump to appender file, or send to remote api with tcp/udp</refpurpose>
@@ -11,18 +10,18 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::flushBuffer</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Flush logs buffer by <link linkend="ini.seaslog.appender">seaslog.appender</link>:
Flush logs buffer by <link linkend="ini.seaslog.appender">seaslog.appender</link>:
dump to file, or send to remote api with tcp/udp.
<note>
<para>
<simpara>
See also:
<link linkend="ini.seaslog.appender-retry">seaslog.appender_retry</link>
<link linkend="ini.seaslog.remote-host">seaslog.remote_host</link>
<link linkend="ini.seaslog.remote-port">seaslog.remote_port</link>
</para>
</simpara>
</note>
</para>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on flush buffer success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -92,7 +91,6 @@ array(0) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/seaslog/seaslog/getbasepath.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getbasepath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getbasepath">
<refnamediv>
<refname>SeasLog::getBasePath</refname>
<refpurpose>Get SeasLog base path.</refpurpose>
@@ -11,16 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Seaslog::getBasePath</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Use the Function <methodname>SeasLog::getBasePath</methodname>
will get the value of <link linkend="ini.seaslog.default-basepath">seaslog.default_basepath</link>
what configured in php.ini(seaslog.ini).
</para>
<para>
</simpara>
<simpara>
If you use <methodname>Seaslog::setBasePath</methodname>, will change the result.
</para>
</simpara>
</refsect1>
@@ -31,9 +30,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return <link linkend="ini.seaslog.default-basepath">seaslog.default_basepath</link> as string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -60,7 +59,6 @@ string(12) "/var/log/www"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/seaslog/seaslog/getbuffer.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getbuffer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getbuffer">
<refnamediv>
<refname>SeasLog::getBuffer</refname>
<refpurpose>Get the logs buffer in memory as array</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>SeasLog::getBuffer</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -26,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return an array from logs buffer in memory.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -80,7 +79,6 @@ array(1) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/seaslog/seaslog/getbufferenabled.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getbufferenabled" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getbufferenabled">
<refnamediv>
<refname>SeasLog::getBufferEnabled</refname>
<refpurpose>Determin if buffer enabled</refpurpose>
@@ -11,12 +10,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::getBufferEnabled</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Result join <link linkend="ini.seaslog.use-buffer">seaslog.use_buffer</link>
<simpara>
Result join <link linkend="ini.seaslog.use-buffer">seaslog.use_buffer</link>
and <link linkend="ini.seaslog.buffer-disabled-in-cli">seaslog.buffer_disabled_in_cli</link>.
</para>
</simpara>
</refsect1>
@@ -27,11 +26,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on <link linkend="ini.seaslog.use-buffer">seaslog.use_buffer</link> is true.
If switch <link linkend="ini.seaslog.buffer-disabled-in-cli">seaslog.buffer_disabled_in_cli</link> on, and running in cli,
If switch <link linkend="ini.seaslog.buffer-disabled-in-cli">seaslog.buffer_disabled_in_cli</link> on, and running in cli,
seaslog.use_buffer setting will be discarded, Seaslog write to the Data Store IMMEDIATELY.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -69,7 +68,6 @@ bool(false)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/seaslog/seaslog/getdatetimeformat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getdatetimeformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getdatetimeformat">
<refnamediv>
<refname>SeasLog::getDatetimeFormat</refname>
<refpurpose>Get SeasLog datetime format style</refpurpose>
@@ -11,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getDatetimeFormat</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Get SeasLog datetime format style.
Use the Function <methodname>SeasLog::getDatetimeFormat</methodname> will
get the value of <link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link>
Use the Function <methodname>SeasLog::getDatetimeFormat</methodname> will
get the value of <link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link>
what configured in php.ini(seaslog.ini).
</para>
</simpara>
</refsect1>
@@ -29,12 +28,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Get SeasLog datetime format style of
<simpara>
Get SeasLog datetime format style of
<link linkend="ini.seaslog.default-datetime-format">seaslog.default_datetime_format</link>.
Use the Function <methodname>SeasLog::setDatetimeFormat</methodname>
Use the Function <methodname>SeasLog::setDatetimeFormat</methodname>
will change this value.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -72,7 +71,6 @@ string(7) "Ymd His"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/seaslog/seaslog/getlastlogger.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getlastlogger" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getlastlogger">
<refnamediv>
<refname>SeasLog::getLastLogger</refname>
<refpurpose>Get SeasLog last logger path</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getLastLogger</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Use the Function <methodname>SeasLog::getLastLogger</methodname> will
get the value of <link linkend="ini.seaslog.default-logger">seaslog.default_logger</link>
<simpara>
Use the Function <methodname>SeasLog::getLastLogger</methodname> will
get the value of <link linkend="ini.seaslog.default-logger">seaslog.default_logger</link>
what configured in php.ini(seaslog.ini).
</para>
</simpara>
</refsect1>
@@ -28,10 +27,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Use the Function <methodname>SeasLog::setLogger</methodname>
<simpara>
Use the Function <methodname>SeasLog::setLogger</methodname>
will change the value of function <methodname>SeasLog::getLastLogger</methodname>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -67,7 +66,6 @@ string(12) "theNewLogger"
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/seaslog/seaslog/getrequestid.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getrequestid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getrequestid">
<refnamediv>
<refname>SeasLog::getRequestID</refname>
<refpurpose>Get SeasLog request_id differentiated requests</refpurpose>
@@ -11,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>SeasLog::getRequestID</methodname>
<void />
<void/>
</methodsynopsis>
<para>
To distinguish a single request, such as not invoking the
<simpara>
To distinguish a single request, such as not invoking the
<methodname>SeasLog::setRequestId</methodname> function，
the unique value generated by the built-in `static char *get_uniqid ()`
the unique value generated by the built-in `static char *get_uniqid ()`
function is used when the request is initialized.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,10 +27,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return string generated by the built-in `static char *get_uniqid ()` function,
or setted by <methodname>SeasLog::setRequestId</methodname> function.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -64,14 +63,13 @@ string(26) "reqeust_id_test_1530864034"
&reftitle.seealso;
<simplelist>
<member><methodname>SeasLog::setRequestID</methodname></member>
<member>The Variable `%Q` in
<member>The Variable `%Q` in
<link linkend="ini.seaslog.default-template">Seaslog Default Variable Table</link>.</member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/seaslog/seaslog/getrequestvariable.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.getrequestvariable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.getrequestvariable">
<refnamediv>
<refname>SeasLog::getRequestVariable</refname>
<refpurpose>Get SeasLog request variable</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::getRequestVariable</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Get SeasLog request variable.
</para>
</simpara>
</refsect1>
@@ -41,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return request variable value on set success.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -108,7 +107,6 @@ bool(false)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/info.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.info">
<refnamediv>
<refname>SeasLog::info</refname>
<refpurpose>Record info log information</refpurpose>
@@ -18,9 +17,9 @@
<para>
Record info log information.
<note>
<para>
<simpara>
"INFO" - Interesting events.Emphasizes the running process of the application.
</para>
</simpara>
</note>
</para>
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -133,7 +132,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/log.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.log" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.log">
<refnamediv>
<refname>SeasLog::log</refname>
<refpurpose>The Common Record Log Function</refpurpose>
@@ -16,9 +15,9 @@
<methodparam choice="opt"><type>array</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The Common Record Log Function.
</para>
</simpara>
</refsect1>
@@ -47,29 +46,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -77,9 +76,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -173,7 +172,6 @@ array(1) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/notice.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.notice" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.notice">
<refnamediv>
<refname>SeasLog::notice</refname>
<refpurpose>Record notice log information</refpurpose>
@@ -18,9 +17,9 @@
<para>
Record notice log information.
<note>
<para>
<simpara>
"NOTICE" - Normal but significant events.Information that is more important than the INFO level during execution.
</para>
</simpara>
</note>
</para>
@@ -32,29 +31,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +61,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -134,7 +133,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/setbasepath.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.setbasepath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setbasepath">
<refnamediv>
<refname>SeasLog::setBasePath</refname>
<refpurpose>Set SeasLog base path</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setBasePath</methodname>
<methodparam><type>string</type><parameter>base_path</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Set SeasLog base path.
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>base_path</parameter></term>
<listitem>
<para>
<simpara>
String.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on setted base path success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -64,7 +63,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/setdatetimeformat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.setdatetimeformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setdatetimeformat">
<refnamediv>
<refname>SeasLog::setDatetimeFormat</refname>
<refpurpose>Set SeasLog datetime format style</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setDatetimeFormat</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Set SeasLog datetime format style.
</para>
</simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<simpara>
String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at <function>date</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on setted datetime format success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -73,7 +72,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/setlogger.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.setlogger" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setlogger">
<refnamediv>
<refname>SeasLog::setLogger</refname>
<refpurpose>Set SeasLog logger name</refpurpose>
@@ -13,11 +12,11 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setLogger</methodname>
<methodparam><type>string</type><parameter>logger</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Use the Function <methodname>SeasLog::setLogger</methodname>
will change the value of function <methodname>SeasLog::getLastLogger</methodname>.
Than's mean, SeasLog will record loginfo into the logger directory.
</para>
</simpara>
</refsect1>
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
<simpara>
Logger name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on created logger disectory success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -74,7 +73,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/seaslog/seaslog/setrequestid.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.setrequestid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setrequestid">
<refnamediv>
<refname>SeasLog::setRequestID</refname>
<refpurpose>Set SeasLog request_id differentiated requests</refpurpose>
@@ -13,12 +12,12 @@
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>SeasLog::setRequestID</methodname>
<methodparam><type>string</type><parameter>request_id</parameter></methodparam>
</methodsynopsis>
<para>
To distinguish a single request, such as not invoking the
<simpara>
To distinguish a single request, such as not invoking the
<methodname>SeasLog::setRequestId</methodname> function，
the unique value generated by the built-in `static char *get_uniqid ()`
the unique value generated by the built-in `static char *get_uniqid ()`
function is used when the request is initialized.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>request_id</parameter></term>
<listitem>
<para>
<simpara>
String.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on set request_id success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -73,7 +72,6 @@ bool(true)
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/seaslog/seaslog/setrequestvariable.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.setrequestvariable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setrequestvariable">
<refnamediv>
<refname>SeasLog::setRequestVariable</refname>
<refpurpose>Manually set SeasLog request variable</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Manually set SeasLog request variable.
</para>
</simpara>
</refsect1>
@@ -40,9 +39,9 @@
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<simpara>
The request variable value.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on set success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -117,7 +116,6 @@ bool(false)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/seaslog/seaslog/warning.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="seaslog.warning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.warning">
<refnamediv>
<refname>SeasLog::warning</refname>
<refpurpose>Record warning log information</refpurpose>
@@ -18,10 +17,10 @@
<para>
Record warning log information.
<note>
<para>
<simpara>
"WARNING" - Exceptional occurrences that are not errors.
Potentially aberrant information that needs attention and needs to be repaired.
</para>
</simpara>
</note>
</para>
@@ -33,29 +32,29 @@
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The log message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
<simpara>
The `message` contain placeholders which implementors replace with values from content array.
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' => neeke)`,
Sush as `message` is `log info from {NAME}` and `content` is `array('NAME' =&gt; neeke)`,
the log information will `log info from neeke`.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>logger</parameter></term>
<listitem>
<para>
The `logger` cased by the third param would be used right this right now,
<simpara>
The `logger` cased by the third param would be used right this right now,
like a temp logger, when the function SeasLog::setLogger() called in pre content.
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</para>
If `logger` NULL or "", SeasLog will use lastest logger setted by <methodname>SeasLog::setLogger</methodname>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -63,9 +62,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return TRUE on record log information success, FALSE on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -134,7 +133,6 @@ array(2) {
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/seaslog/setup.xml
View File

@@ -1,14 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="seaslog.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="seaslog.setup">
&reftitle.setup;
<section xml:id="seaslog.requirements">
&reftitle.required;
<para>
<simpara>
</para>
</simpara>
</section>
<!-- {{{ Installation -->
@@ -21,13 +20,12 @@
<section xml:id="seaslog.resources">
&reftitle.resources;
<para>
<simpara>
</para>
</simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml