From b24d1b736a15981c2ecce20287a89eb960f3b507 Mon Sep 17 00:00:00 2001
From: Sean Coates <sean@php.net>
Date: Sat, 3 Mar 2007 01:17:35 +0000
Subject: [PATCH] apc_add

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@231052 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/apc/functions/apc-add.xml   | 139 ++++++++++++++++++++++++++
 reference/apc/functions/apc-store.xml |   3 +-
 2 files changed, 141 insertions(+), 1 deletion(-)
 create mode 100644 reference/apc/functions/apc-add.xml

diff --git a/reference/apc/functions/apc-add.xml b/reference/apc/functions/apc-add.xml
new file mode 100644
index 0000000000..6f156f8581
--- /dev/null
+++ b/reference/apc/functions/apc-add.xml
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry id="function.apc-add">
+ <refnamediv>
+  <refname>apc_add</refname>
+  <refpurpose>
+   Cache a variable in the data store (only if it's not stored)
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>apc_add</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></methodparam>
+  </methodsynopsis>
+
+  <note>
+   <simpara>
+    Unlike many other mechanisms in PHP, variables stored using
+    <function>apc_add</function> will persist between requests (until the
+    value is removed from the cache).
+   </simpara>
+  </note>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>key</parameter></term>
+     <listitem>
+      <para>
+       Store the variable using this name. <parameter>key</parameter>s are
+       cache-unique, so attempting to use <function>apc_add</function> to
+       store data with a key that already exists will not overwrite the
+       existing data, and will instead return &false;. (This is the only
+       difference between <function>apc_add</function> and
+       <function>apc_store</function>.)
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>var</parameter></term>
+     <listitem>
+      <para>
+       The variable to store
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>ttl</parameter></term>
+     <listitem>
+      <para>
+       Time To Live; store <parameter>var</parameter> in the cache for
+       <parameter>ttl</parameter> seconds. After the
+       <parameter>ttl</parameter> has passed, the stored variable will be
+       expunged from the cache (on the next request). If no <parameter>ttl</parameter>
+       is supplied (or if the <parameter>ttl</parameter> is
+       <literal>0</literal>), the value will persist until it is removed from
+       the cache manually, or otherwise fails to exist in the cache (clear,
+       restart, etc.).
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>apc_add</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$bar = 'BAR';
+apc_add('foo', $bar);
+var_dump(apc_fetch('foo'));
+echo "\n";
+$bar = 'NEVER GETS SET';
+apc_add('foo', $bar);
+var_dump(apc_fetch('foo'));
+echo "\n";
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(3) "BAR"
+string(3) "BAR"
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>apc_store</function></member>
+    <member><function>apc_fetch</function></member>
+    <member><function>apc_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:"../../../../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
+-->
diff --git a/reference/apc/functions/apc-store.xml b/reference/apc/functions/apc-store.xml
index aa41d73248..e5ffc098b7 100644
--- a/reference/apc/functions/apc-store.xml
+++ b/reference/apc/functions/apc-store.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="function.apc-store">
  <refnamediv>
   <refname>apc_store</refname>
@@ -99,6 +99,7 @@ string(3) "BAR"
   &reftitle.seealso;
   <para>
    <simplelist>
+    <member><function>apc_add</function></member>
     <member><function>apc_fetch</function></member>
     <member><function>apc_delete</function></member>
    </simplelist>