Files
doc-fr/reference/apcu/apcuiterator/construct.xml
George Peter Banyard be9f02ea04 Fix RevCheck for APCU docs
2022-06-29 20:16:59 +01:00

117 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c44e9cb68b9b65771f9c45db2c07a06c63d71359 Maintainer: moradZahid Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="apcuiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>APCUIterator::__construct</refname>
<refpurpose>Construit un objet itérateur de la classe APCUIterator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>APCUIterator::__construct</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>search</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>format</parameter><initializer>APC_ITER_ALL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>100</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>list</parameter><initializer>APC_LIST_ACTIVE</initializer></methodparam>
</constructorsynopsis>
<para>
Construit un <type>objet</type> de la classe <classname>APCUIterator</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>search</parameter></term>
<listitem>
<para>
Soit une expression régulière <link linkend="book.pcre">PCRE</link> qui
filtre le nom des clés APCu, donnée sous la forme d'une &string;.
Soit un &array; de &string; contenant des noms de clés APCu.
Ou, bien éventuellement, la valeur &null;, pour sauter l'étape de recherche.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Le format souhaité, configuré avec une ou plusieurs des constantes prédéfinies
<link linkend="apcu.constants">APC_ITER_*</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>chunk_size</parameter></term>
<listitem>
<para>
La taille d'un tronçon. La valeur de ce paramètre doit être plus grand que 0.
La valeur par défaut est 100.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>list</parameter></term>
<listitem>
<para>
Le type de liste. Le paramètre peut prendre soit la valeur <constant>APC_LIST_ACTIVE</constant>
ou bien la valeur <constant>APC_LIST_DELETED</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>APCUIterator::__construct</function></title>
<programlisting role="php">
<![CDATA[
<?php
foreach (new APCUIterator('/^counter\./') as $counter) {
echo "$counter[key]: $counter[value]\n";
apc_dec($counter['key'], $counter['value']);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>apcu_exists</function></member>
<member><function>apcu_cache_info</function></member>
</simplelist>
</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
-->