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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Memcached" namespace="" name="Memcached">
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Create a Memcached instance"/>
<return type="void"/>
</docblock>
<parameter name="persistent_id" optional="true" byreference="false" type="string"/>
</constructor>
<method name="add" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add an item under a new key"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="addByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add an item under a new key on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="addServer" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add a server to the server pool">Memcached::addServer adds the specified server to the server pool. No connection is established to the server at this time, but if you are using consistent key distribution option (via Memcached::DISTRIBUTION_CONSISTENT or Memcached::OPT_LIBKETAMA_COMPATIBLE), some of the internal data structures will have to be updated. Thus, if you need to add multiple servers, it is better to use Memcached::addServers as the update then happens only once.</description>
<return type="bool"/>
</docblock>
<parameter name="host" optional="false" byreference="false" type="string"/>
<parameter name="port" optional="false" byreference="false" type="int"/>
<parameter name="weight" optional="true" byreference="false" type="int"/>
</method>
<method name="addServers" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Add multiple servers to the server pool">Memcached::addServers adds servers to the server pool. Each entry in servers is supposed to be an array containing hostname, port, and, optionally, weight of the server. No connection is established to the servers at this time.</description>
<return type="bool"/>
</docblock>
<parameter name="servers" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="append" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Append data to an existing item">Memcached::append appends the given value string to the value of an existing item. The reason that value is forced to be a string is that appending mixed types is not well-defined.</description>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="appendByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Append data to an existing item on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="cas" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Compare and swap an item"/>
<return type="bool"/>
</docblock>
<parameter name="cas_token" optional="false" byreference="false" type="object" class="float"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="casByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Compare and swap an item on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="cas_token" optional="false" byreference="false" type="object" class="float"/>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="decrement" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Decrement numeric item's value"/>
<return type="int"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="offset" optional="true" byreference="false" type="int"/>
<parameter name="initial_value" optional="true" byreference="false" type="int"/>
<parameter name="expiry" optional="true" byreference="false" type="int"/>
</method>
<method name="decrementByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Decrement numeric item's value, stored on a specific server"/>
<return type="int"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="offset" optional="true" byreference="false" type="int"/>
<parameter name="initial_value" optional="true" byreference="false" type="int"/>
<parameter name="expiry" optional="true" byreference="false" type="int"/>
</method>
<method name="delete" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete an item"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="time" optional="true" byreference="false" type="int"/>
</method>
<method name="deleteByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete an item from a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="time" optional="true" byreference="false" type="int"/>
</method>
<method name="deleteMulti" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete multiple items"/>
<return type="array"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="time" optional="true" byreference="false" type="int"/>
</method>
<method name="deleteMultiByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Delete multiple items from a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="time" optional="true" byreference="false" type="int"/>
</method>
<method name="fetch" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Fetch the next result"/>
<return type="array"/>
</docblock>
</method>
<method name="fetchAll" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Fetch all the remaining results"/>
<return type="array"/>
</docblock>
</method>
<method name="flush" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Invalidate all items in the cache"/>
<return type="bool"/>
</docblock>
<parameter name="delay" optional="true" byreference="false" type="int"/>
</method>
<method name="get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve an item">Memcached::get returns the item that was previously stored under the key. If the item is found and the flags is given Memcached::GET_EXTENDED, it will also return the CAS token value for the item. See Memcached::cas for how to use CAS tokens. Read-through caching callback may be specified via cache_cb parameter.</description>
<return type="mixed"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="cache_cb" optional="true" byreference="false" type="object" class="callable"/>
<parameter name="$flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getAllKeys" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets the keys stored on all the servers"/>
<return type="array"/>
</docblock>
</method>
<method name="getByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve an item from a specific server"/>
<return type="mixed"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="cache_cb" optional="true" byreference="false" type="object" class="callable"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getDelayed" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Request multiple items">Memcached::getDelayed issues a request to memcache for multiple items the keys of which are specified in the keys array. The method does not wait for response and returns right away. When you are ready to collect the items, call either Memcached::fetch or Memcached::fetchAll. If with_cas is true, the CAS token values will also be requested.</description>
<return type="bool"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="with_cas" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="value_cb" optional="true" byreference="false" type="object" class="callable"/>
</method>
<method name="getDelayedByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Request multiple items from a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="with_cas" optional="true" byreference="false" type="object" class="bool"/>
<parameter name="value_cb" optional="true" byreference="false" type="object" class="callable"/>
</method>
<method name="getMulti" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve multiple items">Memcached::getMulti is similar to Memcached::get, but instead of a single key item, it retrieves multiple items the keys of which are specified in the keys array. Before v3.0 a second argument cas_tokens was in use. It was filled with the CAS token values for the found items. The cas_tokens parameter was removed in v3.0 of the extension. It was replaced with a new flag Memcached::GET_EXTENDED that needs is to be used as the value for flags.</description>
<return type="mixed"/>
</docblock>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getMultiByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve multiple items from a specific server"/>
<return type="array"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="keys" optional="false" byreference="false" type="object" class="array"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getOption" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve a Memcached option value"/>
<return type="mixed"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
</method>
<method name="getResultCode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return the result code of the last operation"/>
<return type="int"/>
</docblock>
</method>
<method name="getResultMessage" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return the message describing the result of the last operation"/>
<return type="string"/>
</docblock>
</method>
<method name="getServerByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Map a key to a server"/>
<return type="array"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
</method>
<method name="getServerList" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the list of the servers in the pool"/>
<return type="array"/>
</docblock>
</method>
<method name="getStats" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get server pool statistics"/>
<return type="array"/>
</docblock>
</method>
<method name="getVersion" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get server pool version info"/>
<return type="array"/>
</docblock>
</method>
<method name="increment" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Increment numeric item's value"/>
<return type="int"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="offset" optional="true" byreference="false" type="int"/>
<parameter name="initial_value" optional="true" byreference="false" type="int"/>
<parameter name="expiry" optional="true" byreference="false" type="int"/>
</method>
<method name="incrementByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Increment numeric item's value, stored on a specific server"/>
<return type="int"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="offset" optional="true" byreference="false" type="int"/>
<parameter name="initial_value" optional="true" byreference="false" type="int"/>
<parameter name="expiry" optional="true" byreference="false" type="int"/>
</method>
<method name="isPersistent" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check if a persitent connection to memcache is being used"/>
<return type="bool"/>
</docblock>
</method>
<method name="isPristine" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check if the instance was recently created"/>
<return type="bool"/>
</docblock>
</method>
<method name="prepend" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Prepend data to an existing item">Memcached::prepend prepends the given value string to the value of an existing item. The reason that value is forced to be a string is that prepending mixed types is not well-defined.</description>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="prependByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Prepend data to an existing item on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="string"/>
</method>
<method name="quit" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Close any open connections"/>
<return type="bool"/>
</docblock>
</method>
<method name="replace" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Replace the item under an existing key"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="replaceByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Replace the item under an existing key on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="resetServerList" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clears all servers from the server list"/>
<return type="bool"/>
</docblock>
</method>
<method name="set" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Store an item">Memcached::set stores the value on a memcache server under the specified key. The expiration parameter can be used to control when the value is considered expired.</description>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="setByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Store an item on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="setMulti" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Store multiple items"/>
<return type="bool"/>
</docblock>
<parameter name="items" optional="false" byreference="false" type="object" class="array"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="setMultiByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Store multiple items on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="items" optional="false" byreference="false" type="object" class="array"/>
<parameter name="expiration" optional="true" byreference="false" type="int"/>
</method>
<method name="setOption" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a Memcached option">This method sets the value of a Memcached option. Some options correspond to the ones defined by libmemcached, and some are specific to the extension. See Memcached Constants for more information.</description>
<return type="bool"/>
</docblock>
<parameter name="option" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="setOptions" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set Memcached options"/>
<return type="bool"/>
</docblock>
<parameter name="options" optional="false" byreference="false" type="object" class="array"/>
</method>
<method name="setSaslAuthData" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the credentials to use for authentication">Memcached::setSaslAuthData sets the username and password that should be used for SASL authentication with the memcache servers.</description>
<return type="void"/>
</docblock>
<parameter name="username" optional="false" byreference="false" type="string"/>
<parameter name="password" optional="false" byreference="false" type="string"/>
</method>
<method name="touch" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a new expiration on an item"/>
<return type="bool"/>
</docblock>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="expiration" optional="false" byreference="false" type="int"/>
</method>
<method name="touchByKey" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a new expiration on an item on a specific server"/>
<return type="bool"/>
</docblock>
<parameter name="server_key" optional="false" byreference="false" type="string"/>
<parameter name="key" optional="false" byreference="false" type="string"/>
<parameter name="expiration" optional="false" byreference="false" type="int"/>
</method>
</class>
|
