Files
doc-fr/reference/event/event/timer.xml
George Peter Banyard 09685304ef Sync EN revision tags
These were skipped on my personal revcheck as I hadn't made a tool to generate a batch diff for files with no changes
2021-05-19 19:16:05 +01:00

102 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="event.timer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Event::timer</refname>
<refpurpose>Construit un objet d'événement timer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>Event</type>
<methodname>Event::timer</methodname>
<methodparam>
<type>EventBase</type>
<parameter>base</parameter>
</methodparam>
<methodparam>
<type>callable</type>
<parameter>cb</parameter>
</methodparam>
<methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
</methodparam>
</methodsynopsis>
<para>
Construit un objet d'événement timer. Il s'agit d'une méthode simple pour
créer un événement timer. Notez que la méthode générique
<methodname>Event::__construct</methodname> peut aussi construire des objets
d'événements signal.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<para>
L'objet de base d'événement associé.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>cb</parameter>
</term>
<listitem>
<para>
La fonction de rappel d'événement signal. Voir les
<link linkend="event.callbacks">fonctions de rappel d'événements</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>arg</parameter>
</term>
<listitem>
<para>
Données personnalisées. Si spécifié, elles seront passées à la fonction
de rappel lorsque l'événement lancera les triggers.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un objet d'événement en cas de succès, &false; sinon.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->