<!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>Determin if buffer enabled</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="seaslog.getbuffer.html">SeasLog::getBuffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="seaslog.getdatetimeformat.html">SeasLog::getDatetimeFormat</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.getbufferenabled" class="refentry">
<div class="refnamediv">
<h1 class="refname">SeasLog::getBufferEnabled</h1>
<p class="verinfo">(PECL seaslog >=1.0.0)</p><p class="refpurpose"><span class="refname">SeasLog::getBufferEnabled</span> — <span class="dc-title">Determin if buffer enabled</span></p>
</div>
<div class="refsect1 description" id="refsect1-seaslog.getbufferenabled-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::getBufferEnabled</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Result join <a href="seaslog.configuration.html#ini.seaslog.use-buffer" class="link">seaslog.use_buffer</a>
and <a href="seaslog.configuration.html#ini.seaslog.buffer-disabled-in-cli" class="link">seaslog.buffer_disabled_in_cli</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-seaslog.getbufferenabled-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-seaslog.getbufferenabled-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Return TRUE on <a href="seaslog.configuration.html#ini.seaslog.use-buffer" class="link">seaslog.use_buffer</a> is true.
If switch <a href="seaslog.configuration.html#ini.seaslog.buffer-disabled-in-cli" class="link">seaslog.buffer_disabled_in_cli</a> on, and running in cli,
seaslog.use_buffer setting will be discarded, Seaslog write to the Data Store IMMEDIATELY.
</p>
</div>
<div class="refsect1 examples" id="refsect1-seaslog.getbufferenabled-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4707">
<p><strong>Example #1 <span class="function"><strong>SeasLog::getBufferEnabled()</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">getBufferEnabled</span><span style="color: #007700">());<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(false)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-seaslog.getbufferenabled-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="seaslog.configuration.html#ini.seaslog.use-buffer" class="link">seaslog.use_buffer</a></li>
<li class="member"><a href="seaslog.configuration.html#ini.seaslog.buffer-size" class="link">seaslog.buffer_size</a></li>
<li class="member"><a href="seaslog.configuration.html#ini.seaslog.buffer-disabled-in-cli" class="link">seaslog.buffer_disabled_in_cli</a></li>
<li class="member"><span class="methodname"><a href="seaslog.getbuffer.html" class="methodname" rel="rdfs-seeAlso">SeasLog::getBuffer()</a> - Get the logs buffer in memory as array</span></li>
<li class="member"><span class="methodname"><a href="seaslog.flushbuffer.html" class="methodname" rel="rdfs-seeAlso">SeasLog::flushBuffer()</a> - Flush logs buffer, dump to appender file, or send to remote api with tcp/udp</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.getbuffer.html">SeasLog::getBuffer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="seaslog.getdatetimeformat.html">SeasLog::getDatetimeFormat</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>
