Source of: /manual/en/function.register-tick-function.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.funchand.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.register-tick-function.php',
1 => 'register_tick_function',
),
'up' =>
array (
0 => 'ref.funchand.php',
1 => 'Function handling Functions',
),
'prev' =>
array (
0 => 'function.register-shutdown-function.php',
1 => 'register_shutdown_function',
),
'next' =>
array (
0 => 'function.unregister-tick-function.php',
1 => 'unregister_tick_function',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.register-tick-function" class="refentry">
<div class="refnamediv">
<h1 class="refname">register_tick_function</h1>
<p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">register_tick_function</span> — <span class="dc-title">Register a function for execution on each tick</span></p>
</div>
<a name="function.register-tick-function.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>register_tick_function</b></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.callback" class="type callback">callback</a></span> <tt class="parameter">$function</tt></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$arg</tt></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$...</tt></span>
]] )</div>
<p class="simpara">
Registers the given <i><tt class="parameter">function</tt></i>
to be executed when a
<a href="control-structures.declare.php#control-structures.declare.ticks" class="link">tick</a> is called.
</p>
</div>
<a name="function.register-tick-function.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">function</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The function name as a string, or an array consisting of an object and
a method.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">arg</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">...</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.register-tick-function.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.register-tick-function.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>register_tick_function()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// using a function as the callback<br /></span><span style="color: #0000BB">register_tick_function</span><span style="color: #007700">(</span><span style="color: #DD0000">'my_function'</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// using an object->method<br /></span><span style="color: #0000BB">$object </span><span style="color: #007700">= new </span><span style="color: #0000BB">my_class</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">register_tick_function</span><span style="color: #007700">(array(&</span><span style="color: #0000BB">$object</span><span style="color: #007700">, </span><span style="color: #DD0000">'my_method'</span><span style="color: #007700">), </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.register-tick-function.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">5.3.0</td>
<td align="left">
Ticks are now supported on threaded web server modules.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.register-tick-function.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<div class="warning"><b class="warning">Warning</b>
<p class="para">
<b>register_tick_function()</b> should not be used with
threaded web server modules with PHP 5.2 or lower.
</p>
</div>
</div>
<a name="function.register-tick-function.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="control-structures.declare.php" class="link">declare</a></li>
<li class="member"><a href="function.unregister-tick-function.php" class="function" rel="rdfs-seeAlso">unregister_tick_function()</a> - De-register a function for execution on each tick</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
