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@275074 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski 2009-02-03 00:59:04 +00:00
parent 390b0a76f1
commit 269007e0f5
4 changed files with 44 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,22 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="memcached.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::add</refname>
<refpurpose>The add purpose</refpurpose>
<refpurpose>Add data under a new key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Memcached::add</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Memcached::add</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>expiration</parameter></methodparam>
</methodsynopsis>
<para>
The method description goes here.
<function>Memcached::add</function> is similar to
<methodname>Memcached::set</methodname>, but the operation fails if the
<parameter>key</parameter> already exists on the server.
</para>
</refsect1>
@ -28,7 +30,7 @@
<term><parameter>key</parameter></term>
<listitem>
<para>
Description...
The key under which to store the value.
</para>
</listitem>
</varlistentry>
@ -36,7 +38,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
Description...
The value to store.
</para>
</listitem>
</varlistentry>
@ -44,7 +46,7 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
Description...
The expiration time of the value, as a Unix timestamp.
</para>
</listitem>
</varlistentry>
@ -55,29 +57,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Memcached::add</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
&return.success;
The <methodname>Memcached::getResultCode</methodname> will return
<constant>Memcached::RES_NOTSTORED</constant> if the key already exists.
</para>
</refsect1>
@ -85,7 +67,9 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>Memcached::addByKey</methodname></member>
<member><methodname>Memcached::set</methodname></member>
<member><methodname>Memcached::replace</methodname></member>
</simplelist>
</para>
</refsect1>

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

@ -1,23 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="memcached.addbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::addByKey</refname>
<refpurpose>The addByKey purpose</refpurpose>
<refpurpose>Add data under a new key on a specific server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Memcached::addByKey</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Memcached::addByKey</methodname>
<methodparam><type>string</type><parameter>server_key</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>expiration</parameter></methodparam>
</methodsynopsis>
<para>
The method description goes here.
<function>Memcached::addByKey</function> is functionally equivalent to
<methodname>Memcached::add</methodname>, except that the free-form
<parameter>server_key</parameter> can be used to map the
<parameter>key</parameter> to a specific server. This is useful if you need
to keep a bunch of related keys on a certain server.
</para>
</refsect1>
@ -29,7 +33,7 @@
<term><parameter>server_key</parameter></term>
<listitem>
<para>
Description...
The key identifying the server to store the value on.
</para>
</listitem>
</varlistentry>
@ -37,7 +41,7 @@
<term><parameter>key</parameter></term>
<listitem>
<para>
Description...
The key under which to store the value.
</para>
</listitem>
</varlistentry>
@ -45,7 +49,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
Description...
The value to store.
</para>
</listitem>
</varlistentry>
@ -53,7 +57,7 @@
<term><parameter>expiration</parameter></term>
<listitem>
<para>
Description...
The expiration time of the value, as a Unix timestamp.
</para>
</listitem>
</varlistentry>
@ -64,29 +68,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Memcached::addByKey</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
&return.success;
The <methodname>Memcached::getResultCode</methodname> will return
<constant>Memcached::RES_NOTSTORED</constant> if the key already exists.
</para>
</refsect1>
@ -94,7 +78,9 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
<member><methodname>Memcached::add</methodname></member>
<member><methodname>Memcached::set</methodname></member>
<member><methodname>Memcached::replace</methodname></member>
</simplelist>
</para>
</refsect1>

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

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::set</refname>
<refpurpose>Store data for a key</refpurpose>
<refpurpose>Store data under a key</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -24,7 +24,7 @@
server deletes it to make space for new items.
<para>The value can be any valid PHP type except for resources, because
those cannot be represented in a serialized form. If the
<constant>OPT_COMPRESSION</constant> option is turned on, the serialized
<constant>Memcached::OPT_COMPRESSION</constant> option is turned on, the serialized
value will also be compressed before storage.</para>
</para>
</refsect1>
@ -118,6 +118,8 @@ object(stdClass)#1 (0) {
<para>
<simplelist>
<member><methodname>Memcached::setByKey</methodname></member>
<member><methodname>Memcached::add</methodname></member>
<member><methodname>Memcached::replace</methodname></member>
</simplelist>
</para>
</refsect1>

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

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="memcached.setbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::setByKey</refname>
<refpurpose>Store data for a key on a specific server</refpurpose>
<refpurpose>Store data under a key on a specific server</refpurpose>
</refnamediv>
<refsect1 role="description">