<!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>Constructs timer event object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="event.signal.html">Event::signal</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.eventbase.html">EventBase</a></div> <div class="up"><a href="class.event.html">Event</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="event.timer" class="refentry"> <div class="refnamediv"> <h1 class="refname">Event::timer</h1> <p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">Event::timer</span> — <span class="dc-title">Constructs timer event object</span></p> </div> <div class="refsect1 description" id="refsect1-event.timer-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type"><a href="class.event.html" class="type Event">Event</a></span> <span class="methodname"><strong>Event::timer</strong></span> ( <span class="methodparam"> <span class="type"><a href="class.eventbase.html" class="type EventBase">EventBase</a></span> <code class="parameter">$base</code> </span> , <span class="methodparam"> <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$cb</code> </span> [, <span class="methodparam"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$arg</code> </span> ] )</div> <p class="para rdfs-comment"> Constructs timer event object. This is a straightforward method to create a timer event. Note, the generic <span class="methodname"><a href="event.construct.html" class="methodname">Event::__construct()</a></span> method can contruct signal event objects too. </p> </div> <div class="refsect1 parameters" id="refsect1-event.timer-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"> <em><code class="parameter">base</code></em> </span> <dd> <p class="para"> The associated event base object. </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">cb</code></em> </span> <dd> <p class="para"> The signal event callback. See <a href="event.callbacks.html" class="link">Event callbacks</a> . </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">arg</code></em> </span> <dd> <p class="para"> Custom data. If specified, it will be passed to the callback when event triggers. </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-event.timer-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns Event object on success. Otherwise <strong><code>FALSE</code></strong>. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="event.signal.html">Event::signal</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.eventbase.html">EventBase</a></div> <div class="up"><a href="class.event.html">Event</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>