sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

memcached docs progress.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275122 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski 2009-02-03 21:39:35 +00:00
parent dfc350e8c5
commit 4de5ce1452
12 changed files with 119 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
reference/memcached/book.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<book xml:id="book.memcached" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Memcached</title>
@ -32,6 +32,7 @@
&reference.memcached.setup;
&reference.memcached.constants;
&reference.memcached.examples;
&reference.memcached.expiration;
&reference.memcached.memcached;
</book>

43
reference/memcached/expiration.xml Normal file
View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<chapter xml:id="memcached.expiration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Expiration Times</title>
<para>
Some storage commands involve sending an expiration value (relative to an
item or to an operation requested by the client) to the server. In all such
cases, the actual value sent may either be Unix time (number of seconds
since January 1, 1970, as an integer), or a number of seconds starting from
current time. In the latter case, this number of seconds may not exceed
60*60*24*30 (number of seconds in 30 days); if the expiration value is
larger than that, the server will consider it to be real Unix time value
rather than an offset from current time.
</para>
<para>
If the expiration value is <literal>0</literal> (the default), the item
never expires (although it may be deleted from the server to make place for
other items).
</para>
</chapter>
<!-- 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
-->

5
reference/memcached/memcached/add.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -46,7 +46,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

5
reference/memcached/memcached/addbykey.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.addbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -57,7 +57,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

45
reference/memcached/memcached/delete.xml
View file

@ -1,21 +1,33 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="memcached.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::delete</refname>
<refpurpose>The delete purpose</refpurpose>
<refpurpose>Delete an item</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Memcached::delete</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Memcached::delete</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>time</parameter></methodparam>
</methodsynopsis>
<para>
The method description goes here.
<function>Memcached::delete</function> deletes the
<parameter>key</parameter> from the server. The <parameter>time</parameter>
parameter is the amount of time in seconds (or Unix time until which) the
client wishes the server to refuse <literal>add</literal> and
<literal>replace</literal> commands for this key. For this amount of time,
the item is put into a delete queue, which means that it won't possible to
retrieve it by the <literal>get</literal> command, but
<literal>add</literal> and <literal>replace</literal> command with this key
will also fail (the <literal>set</literal> command will succeed, however).
After the time passes, the item is finally deleted from server memory. The
parameter <parameter>time</parameter> defaults to 0 (which means that the
item will be deleted immediately and further storage commands with this key
will succeed).
</para>
</refsect1>
@ -27,15 +39,16 @@
<term><parameter>key</parameter></term>
<listitem>
<para>
Description...
The key to be deleted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>expiration</parameter></term>
<term><parameter>time</parameter></term>
<listitem>
<para>
Description...
The amount of time the server will wait to delete the item. Defaults to
<literal>0</literal>.
</para>
</listitem>
</varlistentry>
@ -46,7 +59,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
&return.success;
Use <methodname>Memcached::getResultCode</methodname> if necessary.
</para>
</refsect1>
@ -58,16 +72,13 @@
<programlisting role="php">
<![CDATA[
<?php
/* ... */
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->delete('key1');
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
@ -76,7 +87,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>Memcached::deleteByKey</methodname></member>
</simplelist>
</para>
</refsect1>

49
reference/memcached/memcached/deletebykey.xml
View file

@ -1,22 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="memcached.deletebykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::deleteByKey</refname>
<refpurpose>The deleteByKey purpose</refpurpose>
<refpurpose>Delete an item from a specific server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Memcached::deleteByKey</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Memcached::deleteByKey</methodname>
<methodparam><type>string</type><parameter>server_key</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>time</parameter></methodparam>
</methodsynopsis>
<para>
The method description goes here.
<function>Memcached::deleteByKey</function> is functionally equivalent to
<methodname>Memcached::delete</methodname>, except that the free-form
<parameter>server_key</parameter> can be used to map the
<parameter>key</parameter> to a specific server.
</para>
</refsect1>
@ -28,7 +31,7 @@
<term><parameter>server_key</parameter></term>
<listitem>
<para>
Description...
The key identifying the server to delete the item from.
</para>
</listitem>
</varlistentry>
@ -36,15 +39,16 @@
<term><parameter>key</parameter></term>
<listitem>
<para>
Description...
The key to be deleted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>expiration</parameter></term>
<term><parameter>time</parameter></term>
<listitem>
<para>
Description...
The amount of time the server will wait to delete the item. Defaults to
<literal>0</literal>.
</para>
</listitem>
</varlistentry>
@ -55,29 +59,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Memcached::deleteByKey</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
&return.success;
Use <methodname>Memcached::getResultCode</methodname> if necessary.
</para>
</refsect1>
@ -85,7 +68,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>Memcached::delete</methodname></member>
</simplelist>
</para>
</refsect1>

5
reference/memcached/memcached/replace.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.replace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -46,7 +46,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

5
reference/memcached/memcached/replacebykey.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.replacebykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -57,7 +57,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

19
reference/memcached/memcached/set.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="memcached.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -18,16 +18,14 @@
<para>
<function>Memcached::set</function> stores the <parameter>value</parameter>
on a memcache server under the specified <parameter>key</parameter>. The
<parameter>expiration</parameter> parameter is a Unix timestamp that can be
used to control when the value is considered expired. It can be set to
<literal>0</literal> which means that the value will persist until the
server deletes it to make space for new items.
<parameter>expiration</parameter> parameter can be used to control when the
value is considered expired.
</para>
<para>
The value can be any valid PHP type except for resources, because
those cannot be represented in a serialized form. If the
<constant>Memcached::OPT_COMPRESSION</constant> option is turned on, the serialized
value will also be compressed before storage.
The value can be any valid PHP type except for resources, because those
cannot be represented in a serialized form. If the
<constant>Memcached::OPT_COMPRESSION</constant> option is turned on, the
serialized value will also be compressed before storage.
</para>
</refsect1>
@ -55,7 +53,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

5
reference/memcached/memcached/setbykey.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="memcached.setbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -57,7 +57,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the value, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

5
reference/memcached/memcached/setmulti.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.setmulti" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -39,7 +39,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the entries, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>

5
reference/memcached/memcached/setmultibykey.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.setmultibykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@ -48,7 +48,8 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
The expiration time of the entries, as a Unix timestamp.
The expiration time, defaults to 0. See <link
linkend="memcached.expiration">Expiration Times</link> for more info.
</para>
</listitem>
</varlistentry>