mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
71602d3f23
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@203574 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3.1 KiB
XML
124 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<refentry id="function.Memcache-increment">
|
|
<refnamediv>
|
|
<refname>Memcache::increment</refname>
|
|
<refpurpose>Increment item's value</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>Memcache::increment</methodname>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
<function>Memcache::increment</function> increments value of the item on
|
|
the specified <parameter>value</parameter>. If item with key
|
|
<parameter>key</parameter> was not numeric and cannot be converted to
|
|
number, it will change it's value to <parameter>value</parameter>.
|
|
<function>Memcache::increment</function> <emphasis>does not</emphasis>
|
|
create an item if it didn't exist.
|
|
<note>
|
|
<para>
|
|
Do not use <function>Memcache::increment</function> with item, which was
|
|
stored compressed, because consequent call to
|
|
<function>Memcache::get</function> will fail.
|
|
</para>
|
|
</note>
|
|
Also you can use <function>memcache_increment</function> function.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Optional and default to 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns new item's value on success or &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>Memcache::increment</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* procedural API */
|
|
$memcache_obj = memcache_connect('memcache_host', 11211);
|
|
/* increment counter by 2 */
|
|
$current_value = memcache_increment($memcache_obj, 'counter', 2);
|
|
|
|
/* OO API */
|
|
$memcache_obj = new Memcache;
|
|
$memcache_obj->connect('memcache_host', 11211);
|
|
/* increment counter by 3 */
|
|
$current_value = $memcache_obj->increment('counter', 3);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>Memcache::decrement</function></member>
|
|
<member><function>Memcache::replace</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
|
|
-->
|