<!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>Set a callback function to be called on events</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongolog.getmodule.html">MongoLog::getModule</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongolog.setlevel.html">MongoLog::setLevel</a></div>
<div class="up"><a href="class.mongolog.html">MongoLog</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongolog.setcallback" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoLog::setCallback</h1>
<p class="verinfo">(PECL mongo >= 1.3.0)</p><p class="refpurpose"><span class="refname">MongoLog::setCallback</span> — <span class="dc-title">Set a callback function to be called on events</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongolog.setcallback-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>MongoLog::setCallback</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$log_function</code></span>
)</div>
<p class="para rdfs-comment">
This function will set a callback function to be called for <a href="class.mongolog.html" class="classname">MongoLog</a> events
instead of triggering warnings.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongolog.setcallback-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">log_function</code></em></span>
<dd>
<p class="para">
The function to be called on events.
</p>
<p class="para">
The function should have the following prototype
</p>
<p class="para">
<div class="methodsynopsis dc-description">
<span class="methodname"><span class="replaceable">log_function</span></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$module</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$level</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$message</code></span>
)</div>
<dl>
<dt>
<span class="term"><em><code class="parameter">module</code></em></span>
<dd>
<span class="simpara">
One of the <a href="class.mongolog.html#mongolog.constants.module" class="link">MongoLog
module constants</a>.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">level</code></em></span>
<dd>
<span class="simpara">
One of the <a href="class.mongolog.html#mongolog.constants.level" class="link">MongoLog
level constants</a>.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">message</code></em></span>
<dd>
<span class="simpara">
The log message itself.
</span>
</dd>
</dt>
</dl>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongolog.setcallback-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongolog.setcallback-examples">
<h3 class="title">Examples</h3>
<div class="example" id="mongolog.setcallback.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>MongoLog::setCallback()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">module2string</span><span style="color: #007700">(</span><span style="color: #0000BB">$module</span><span style="color: #007700">)<br />{<br /> switch (</span><span style="color: #0000BB">$module</span><span style="color: #007700">) {<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">RS</span><span style="color: #007700">: return </span><span style="color: #DD0000">"REPLSET"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">CON</span><span style="color: #007700">: return </span><span style="color: #DD0000">"CON"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">IO</span><span style="color: #007700">: return </span><span style="color: #DD0000">"IO"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">SERVER</span><span style="color: #007700">: return </span><span style="color: #DD0000">"SERVER"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">PARSE</span><span style="color: #007700">: return </span><span style="color: #DD0000">"PARSE"</span><span style="color: #007700">;<br /> default: return </span><span style="color: #DD0000">"UNKNOWN"</span><span style="color: #007700">;<br /> }<br />}<br /><br />function </span><span style="color: #0000BB">level2string</span><span style="color: #007700">(</span><span style="color: #0000BB">$level</span><span style="color: #007700">)<br />{<br /> switch (</span><span style="color: #0000BB">$level</span><span style="color: #007700">) {<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">WARNING</span><span style="color: #007700">: return </span><span style="color: #DD0000">"WARN"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">INFO</span><span style="color: #007700">: return </span><span style="color: #DD0000">"INFO"</span><span style="color: #007700">;<br /> case </span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">FINE</span><span style="color: #007700">: return </span><span style="color: #DD0000">"FINE"</span><span style="color: #007700">;<br /> default: </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$level</span><span style="color: #007700">); return </span><span style="color: #DD0000">"UNKNOWN"</span><span style="color: #007700">;<br /> }<br />}<br /><br /><br />function </span><span style="color: #0000BB">callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$module</span><span style="color: #007700">, </span><span style="color: #0000BB">$level</span><span style="color: #007700">, </span><span style="color: #0000BB">$message</span><span style="color: #007700">)<br />{<br /> echo </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">"Y-m-d H:i:s - "</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s (%s): %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">module2string</span><span style="color: #007700">(</span><span style="color: #0000BB">$module</span><span style="color: #007700">), </span><span style="color: #0000BB">level2string</span><span style="color: #007700">(</span><span style="color: #0000BB">$level</span><span style="color: #007700">), </span><span style="color: #0000BB">$message</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">setLevel</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">ALL</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">setModule</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">ALL</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">MongoLog</span><span style="color: #007700">::</span><span style="color: #0000BB">setCallback</span><span style="color: #007700">(</span><span style="color: #DD0000">"callback"</span><span style="color: #007700">);<br /><br />new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<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>
2013-07-09 09:41:42 - PARSE (INFO): Parsing localhost:27017
2013-07-09 09:41:42 - PARSE (INFO): - Found node: localhost:27017
2013-07-09 09:41:42 - PARSE (INFO): - Connection type: STANDALONE
2013-07-09 09:41:42 - CON (INFO): mongo_get_read_write_connection: finding a STANDALONE connection
2013-07-09 09:41:42 - CON (INFO): connection_create: creating new connection for localhost:27017
2013-07-09 09:41:42 - CON (INFO): stream_connect: Not establishing SSL for localhost:27017
2013-07-09 09:41:42 - CON (INFO): get_server_flags: start
2013-07-09 09:41:42 - CON (FINE): send_packet: read from header: 36
2013-07-09 09:41:42 - CON (FINE): send_packet: data_size: 95
2013-07-09 09:41:42 - CON (FINE): get_server_flags: setting maxBsonObjectSize to 16777216
2013-07-09 09:41:42 - CON (FINE): get_server_flags: setting maxMessageSizeBytes to 48000000
2013-07-09 09:41:42 - CON (INFO): is_ping: pinging localhost:27017;-;.;1543
2013-07-09 09:41:42 - CON (FINE): send_packet: read from header: 36
2013-07-09 09:41:42 - CON (FINE): send_packet: data_size: 17
2013-07-09 09:41:42 - CON (INFO): is_ping: last pinged at 1373359302; time: 0ms
2013-07-09 09:41:42 - REPLSET (FINE): finding candidate servers
2013-07-09 09:41:42 - REPLSET (FINE): - all servers
2013-07-09 09:41:42 - REPLSET (FINE): filter_connections: adding connections:
2013-07-09 09:41:42 - REPLSET (FINE): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
2013-07-09 09:41:42 - REPLSET (FINE): filter_connections: done
2013-07-09 09:41:42 - REPLSET (FINE): limiting by seeded/discovered servers
2013-07-09 09:41:42 - REPLSET (FINE): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
2013-07-09 09:41:42 - REPLSET (FINE): limiting by seeded/discovered servers: done
2013-07-09 09:41:42 - REPLSET (FINE): limiting by credentials
2013-07-09 09:41:42 - REPLSET (FINE): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
2013-07-09 09:41:42 - REPLSET (FINE): limiting by credentials: done
2013-07-09 09:41:42 - REPLSET (FINE): sorting servers by priority and ping time
2013-07-09 09:41:42 - REPLSET (FINE): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
2013-07-09 09:41:42 - REPLSET (FINE): sorting servers: done
2013-07-09 09:41:42 - REPLSET (FINE): selecting near servers
2013-07-09 09:41:42 - REPLSET (FINE): selecting near servers: nearest is 0ms
2013-07-09 09:41:42 - REPLSET (FINE): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
2013-07-09 09:41:42 - REPLSET (FINE): selecting near server: done
2013-07-09 09:41:42 - REPLSET (INFO): pick server: random element 0
2013-07-09 09:41:42 - REPLSET (INFO): - connection: type: STANDALONE, socket: 42, ping: 0, hash: localhost:27017;-;.;1543
</pre></div>
</div>
</div>
</div>
<div class="refsect1 notes" id="refsect1-mongolog.setcallback-notes">
<h3 class="title">Notes</h3>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
This function is only available with PHP 5.3.0 and later.
</p>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongolog.getmodule.html">MongoLog::getModule</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongolog.setlevel.html">MongoLog::setLevel</a></div>
<div class="up"><a href="class.mongolog.html">MongoLog</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
