<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.seaslog.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'seaslog.log.php',
1 => 'SeasLog::log',
),
'up' =>
array (
0 => 'class.seaslog.php',
1 => 'SeasLog',
),
'prev' =>
array (
0 => 'seaslog.info.php',
1 => 'SeasLog::info',
),
'next' =>
array (
0 => 'seaslog.notice.php',
1 => 'SeasLog::notice',
),
'alternatives' =>
array (
),
'source' =>
array (
'lang' => 'en',
'path' => 'reference/seaslog/seaslog/log.xml',
),
'history' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);
contributors($setup);
?>
<div id="seaslog.log" class="refentry">
<div class="refnamediv">
<h1 class="refname">SeasLog::log</h1>
<p class="verinfo">(PECL seaslog >=1.0.0)</p><p class="refpurpose"><span class="refname">SeasLog::log</span> — <span class="dc-title">The Common Record Log Function</span></p>
</div>
<div class="refsect1 description" id="refsect1-seaslog.log-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><strong>SeasLog::log</strong></span>(<br> <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$level</code></span>,<br> <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$message</code><span class="initializer"> = ?</span></span>,<br> <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$content</code><span class="initializer"> = ?</span></span>,<br> <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$logger</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<p class="para rdfs-comment">
The Common Record Log Function.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-seaslog.log-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt><code class="parameter">level</code></dt>
<dd>
<p class="para">
Can use level in:
<ul class="simplelist">
<li><a href="seaslog.constants.php#constant.seaslog-debug" class="link">SEASLOG_DEBUG</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-info" class="link">SEASLOG_INFO</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-notice" class="link">SEASLOG_NOTICE</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-warning" class="link">SEASLOG_WARNING</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-error" class="link">SEASLOG_ERROR</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-critical" class="link">SEASLOG_CRITICAL</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-alert" class="link">SEASLOG_ALERT</a></li>
<li><a href="seaslog.constants.php#constant.seaslog-emergency" class="link">SEASLOG_EMERGENCY</a></li>
</ul>
Or you can create a new level self-help.
</p>
</dd>
<dt><code class="parameter">message</code></dt>
<dd>
<p class="para">
The log message.
</p>
</dd>
<dt><code class="parameter">content</code></dt>
<dd>
<p class="para">
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)`,
the log information will `log info from neeke`.
</p>
</dd>
<dt><code class="parameter">logger</code></dt>
<dd>
<p class="para">
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 <span class="methodname"><a href="seaslog.setlogger.php" class="methodname">SeasLog::setLogger()</a></span>.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-seaslog.log-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Return TRUE on record log information success, FALSE on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-seaslog.log-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3836">
<p><strong>Example #1 <span class="function"><strong>SeasLog::log()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /><br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">log</span><span style="color: #007700">(</span><span style="color: #0000BB">SEASLOG_INFO</span><span style="color: #007700">,</span><span style="color: #DD0000">'info log'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">getBuffer</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">//create a new level self-help.<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">log</span><span style="color: #007700">(</span><span style="color: #DD0000">'MySelfLevel'</span><span style="color: #007700">,</span><span style="color: #DD0000">'info log'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">getBuffer</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">//with `content`<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">log</span><span style="color: #007700">(</span><span style="color: #DD0000">'MySelfLevel'</span><span style="color: #007700">,</span><span style="color: #DD0000">'info log {NAME}'</span><span style="color: #007700">,array(</span><span style="color: #DD0000">'NAME' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'neeke'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">getBuffer</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">//with `logger`<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">log</span><span style="color: #007700">(</span><span style="color: #DD0000">'MySelfLevel'</span><span style="color: #007700">,</span><span style="color: #DD0000">'info log {NAME}'</span><span style="color: #007700">,array(</span><span style="color: #DD0000">'NAME' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'neeke'</span><span style="color: #007700">),</span><span style="color: #DD0000">'tmp_logger'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">SeasLog</span><span style="color: #007700">::</span><span style="color: #0000BB">getBuffer</span><span style="color: #007700">());<br /><br /><br /></span><span style="color: #0000BB">?></span></span></code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">bool(true)
array(1) {
["/var/log/www/default/20180707.log"]=>
array(1) {
[0]=>
string(79) "2018-07-07 11:12:37 | INFO | 72427 | 5b402fa56a2ea | 1530933157.436 | info log
"
}
}
bool(true)
array(1) {
["/var/log/www/default/20180707.log"]=>
array(1) {
[0]=>
string(86) "2018-07-07 11:13:59 | MySelfLevel | 72470 | 5b402ff781c5e | 1530933239.532 | info log
"
}
}
bool(true)
array(1) {
["/var/log/www/tmp_logger/20180707.log"]=>
array(1) {
[0]=>
string(92) "2018-07-07 11:28:12 | MySelfLevel | 72833 | 5b40334ce6a2f | 1530934092.946 | info log neeke
"
}
}
bool(true)
array(1) {
["/var/log/www/default/20180707.log"]=>
array(1) {
[0]=>
string(86) "2018-07-07 11:20:12 | INFO | 72616 | 5b40316c3641e | 1530933612.222 | info log neeke
"
}
}</pre>
</div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-seaslog.log-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li><a href="seaslog.configuration.php#ini.seaslog.default-template" class="link">seaslog.default_template</a></li>
<li><span class="methodname"><a href="seaslog.debug.php" class="methodname" rel="rdfs-seeAlso">SeasLog::debug()</a> - Record debug log information</span></li>
<li><span class="methodname"><a href="seaslog.info.php" class="methodname" rel="rdfs-seeAlso">SeasLog::info()</a> - Record info log information</span></li>
<li><span class="methodname"><a href="seaslog.notice.php" class="methodname" rel="rdfs-seeAlso">SeasLog::notice()</a> - Record notice log information</span></li>
<li><span class="methodname"><a href="seaslog.warning.php" class="methodname" rel="rdfs-seeAlso">SeasLog::warning()</a> - Record warning log information</span></li>
<li><span class="methodname"><a href="seaslog.error.php" class="methodname" rel="rdfs-seeAlso">SeasLog::error()</a> - Record error log information</span></li>
<li><span class="methodname"><a href="seaslog.critical.php" class="methodname" rel="rdfs-seeAlso">SeasLog::critical()</a> - Record critical log information</span></li>
<li><span class="methodname"><a href="seaslog.alert.php" class="methodname" rel="rdfs-seeAlso">SeasLog::alert()</a> - Record alert log information</span></li>
<li><span class="methodname"><a href="seaslog.emergency.php" class="methodname" rel="rdfs-seeAlso">SeasLog::emergency()</a> - Record emergency log information</span></li>
</ul>
</div>
</div><?php manual_footer($setup); ?>