doc-fr/reference/apcu/functions/apcu-store.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e9366ee458b2900c53a503b1ad97664e1d9a8859 Maintainer: moradZahid Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.apcu-store" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apcu_store</refname>
  <refpurpose>
   Met en cache une variable dans le dépôt de données
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>apcu_store</methodname>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>array</type><methodname>apcu_store</methodname>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>unused</parameter><initializer>NULL</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>ttl</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Met en cache une variable dans le dépôt de données.
  </para>
  <note>
   <simpara>
    Contrairement à de nombreux autres mécanismes dans PHP, les variables stockées
    utilisant <function>apcu_store</function> persisteront entre les requêtes (jusqu'à ce
    que leurs valeurs soient retirées du cache).
   </simpara>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Stocke la variable en utilisant ce nom de clé. Chaque clé est unique dans le cache,
       stocker une seconde valeur avec le même paramètre <parameter>key</parameter> 
       va réécrire sur la valeur originale.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>var</parameter></term>
     <listitem>
      <para>
       La variable à stocker.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ttl</parameter></term>
     <listitem>
      <para>
       Durée de vie; stocke la variable <parameter>var</parameter> dans le cache pour
       une durée de <parameter>ttl</parameter> secondes. Après l'expiration de
       <parameter>ttl</parameter>, la variable stockée sera retirée du cache (à la 
       prochaine requête). Si aucune valeur n'est passée au paramètre 
       <parameter>ttl</parameter> (ou si la valeur de <parameter>ttl</parameter> est
       <literal>0</literal>), la variable persistera jusqu'à qu'elle soit retirée
       manuellement du cache, ou, sinon, elle échouera à sortir du cache (lors d'un 
       effaçage, redémarrage, etc.).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Les noms sont fournis par les clés du tableau <parameter>values</parameter>,
       les variables par les valeurs.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   La seconde syntaxe retourne un tableau avec les clés erronées.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un exemple avec <function>apcu_store</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(3) "BAR"
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>apcu_add</function></member>
    <member><function>apcu_fetch</function></member>
    <member><function>apcu_delete</function></member>
   </simplelist>
  </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
-->