reference/memcached/memcached/getbykey.xml
1d8068ecb070fdc360d750e0c1f3f15796e61ec0
1d8068ecb070fdc360d750e0c1f3f15796e61ec0
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="memcached.getbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>Memcached::getByKey</refname>
...
...
@@ -9,12 +8,12 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<methodsynopsis role="Memcached">
13
12
<modifier>public</modifier> <type>mixed</type><methodname>Memcached::getByKey</methodname>
14
13
<methodparam><type>string</type><parameter>server_key</parameter></methodparam>
15
14
<methodparam><type>string</type><parameter>key</parameter></methodparam>
16
-
<methodparam choice="opt"><type>callable</type><parameter>cache_cb</parameter></methodparam>
17
-
<methodparam choice="opt"><type>float</type><parameter role="reference">cas_token</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>cache_cb</parameter><initializer>&null;</initializer></methodparam>
16
+
<methodparam choice="opt"><type>int</type><parameter>get_flags</parameter><initializer>0</initializer></methodparam>
18
17
</methodsynopsis>
19
18
<para>
20
19
<function>Memcached::getByKey</function> is functionally equivalent to
...
...
@@ -53,10 +52,11 @@
53
52
</listitem>
54
53
</varlistentry>
55
54
<varlistentry>
56
-
<term><parameter>cas_token</parameter></term>
55
+
<term><parameter>get_flags</parameter></term>
57
56
<listitem>
58
57
<para>
59
-
The variable to store the CAS token in.
58
+
Flags to control the returned result. When value of <constant>Memcached::GET_EXTENDED</constant>
59
+
is given will return the CAS token.
60
60
</para>
61
61
</listitem>
62
62
</varlistentry>
...
...
@@ -73,6 +73,29 @@
73
73
</para>
74
74
</refsect1>
75
75
76
+
<refsect1 role="changelog">
77
+
&reftitle.changelog;
78
+
<informaltable>
79
+
<tgroup cols="2">
80
+
<thead>
81
+
<row>
82
+
<entry>&Version;</entry>
83
+
<entry>&Description;</entry>
84
+
</row>
85
+
</thead>
86
+
<tbody>
87
+
<row>
88
+
<entry>PECL memcached 3.0.0</entry>
89
+
<entry>
90
+
The <parameter role="reference">cas_token</parameter> parameter was removed.
91
+
Instead <parameter>get_flags</parameter> was added and when it is given the value of <constant>Memcached::GET_EXTENDED</constant> it will ensure the CAS token to be fetched.
92
+
</entry>
93
+
</row>
94
+
</tbody>
95
+
</tgroup>
96
+
</informaltable>
97
+
</refsect1>
98
+
76
99
<refsect1 role="seealso">
77
100
&reftitle.seealso;
78
101
<para>
...
...
@@ -85,7 +108,6 @@
85
108
</refsect1>
86
109
87
110
</refentry>
88
-
89
111
<!-- Keep this comment at the end of the file
90
112
Local variables:
91
113
mode: sgml
92
114