1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.Memcache-increment">
<refnamediv>
<refname>Memcache::increment</refname>
<refpurpose>Increment item's value</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
<para>
Parameter <parameter>value</parameter> is optional. It's default value is
1.
</para>
<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>
<para>
Also you can use <function>memcache_increment</function> function.
See example below.
</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>
<function>Memcache::increment</function> returns new item's value on
success or &false; on failure.
</para>
<para>
<function>Memcache::increment</function> <emphasis>does not</emphasis>
create an item if it didn't exist.
</para>
<para>
See also
<function>Memcache::decrement</function>,
<function>Memcache::replace</function>.
</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
-->
|
