<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>The Common Record Log Function</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="seaslog.info.html">SeasLog::info</a></div> <div class="next" style="text-align: right; float: right;"><a href="seaslog.notice.html">SeasLog::notice</a></div> <div class="up"><a href="class.seaslog.html">SeasLog</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><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="type">bool</span> <span class="methodname"><strong>SeasLog::log</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$level</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$message</code></span> [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$content</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$logger</code></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 class="member"><a href="seaslog.constants.html#constant.seaslog-debug" class="link">SEASLOG_DEBUG</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-info" class="link">SEASLOG_INFO</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-notice" class="link">SEASLOG_NOTICE</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-warning" class="link">SEASLOG_WARNING</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-error" class="link">SEASLOG_ERROR</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-critical" class="link">SEASLOG_CRITICAL</a></li> <li class="member"><a href="seaslog.constants.html#constant.seaslog-alert" class="link">SEASLOG_ALERT</a></li> <li class="member"><a href="seaslog.constants.html#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.html" 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-4712"> <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="cdata"><pre> 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 class="member"><a href="seaslog.configuration.html#ini.seaslog.default-template" class="link">seaslog.default_template</a></li> <li class="member"><span class="methodname"><a href="seaslog.debug.html" class="methodname" rel="rdfs-seeAlso">SeasLog::debug()</a> - Record debug log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.info.html" class="methodname" rel="rdfs-seeAlso">SeasLog::info()</a> - Record info log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.notice.html" class="methodname" rel="rdfs-seeAlso">SeasLog::notice()</a> - Record notice log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.warning.html" class="methodname" rel="rdfs-seeAlso">SeasLog::warning()</a> - Record warning log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.error.html" class="methodname" rel="rdfs-seeAlso">SeasLog::error()</a> - Record error log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.critical.html" class="methodname" rel="rdfs-seeAlso">SeasLog::critical()</a> - Record critical log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.alert.html" class="methodname" rel="rdfs-seeAlso">SeasLog::alert()</a> - Record alert log information</span></li> <li class="member"><span class="methodname"><a href="seaslog.emergency.html" class="methodname" rel="rdfs-seeAlso">SeasLog::emergency()</a> - Record emergency log information</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="seaslog.info.html">SeasLog::info</a></div> <div class="next" style="text-align: right; float: right;"><a href="seaslog.notice.html">SeasLog::notice</a></div> <div class="up"><a href="class.seaslog.html">SeasLog</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>