forked from HvyIndustries/crane-php-stubs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
memcached.php
1402 lines (1271 loc) · 48.5 KB
/
memcached.php
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// Start of memcached v.2.2.0
/**
* Represents a connection to a set of memcached servers.
* @link http://php.net/manual/en/class.memcached.php
*/
class Memcached {
const LIBMEMCACHED_VERSION_HEX = 16777240;
/**
* <p>Enables or disables payload compression. When enabled,
* item values longer than a certain threshold (currently 100 bytes) will be
* compressed during storage and decompressed during retrieval
* transparently.</p>
* <p>Type: boolean, default: <b>TRUE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_COMPRESSION = -1001;
const OPT_COMPRESSION_TYPE = -1004;
/**
* <p>This can be used to create a "domain" for your item keys. The value
* specified here will be prefixed to each of the keys. It cannot be
* longer than 128 characters and will reduce the
* maximum available key size. The prefix is applied only to the item keys,
* not to the server keys.</p>
* <p>Type: string, default: "".</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_PREFIX_KEY = -1002;
/**
* <p>
* Specifies the serializer to use for serializing non-scalar values.
* The valid serializers are <b>Memcached::SERIALIZER_PHP</b>
* or <b>Memcached::SERIALIZER_IGBINARY</b>. The latter is
* supported only when memcached is configured with
* --enable-memcached-igbinary option and the
* igbinary extension is loaded.
* </p>
* <p>Type: integer, default: <b>Memcached::SERIALIZER_PHP</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_SERIALIZER = -1003;
const OPT_STORE_RETRY_COUNT = -1005;
/**
* <p>Indicates whether igbinary serializer support is available.</p>
* <p>Type: boolean.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HAVE_IGBINARY = 0;
/**
* <p>Indicates whether JSON serializer support is available.</p>
* <p>Type: boolean.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HAVE_JSON = 0;
const HAVE_MSGPACK = 0;
const HAVE_SESSION = 1;
const HAVE_SASL = 1;
/**
* <p>Specifies the hashing algorithm used for the item keys. The valid
* values are supplied via <b>Memcached::HASH_*</b> constants.
* Each hash algorithm has its advantages and its disadvantages. Go with the
* default if you don't know or don't care.</p>
* <p>Type: integer, default: <b>Memcached::HASH_DEFAULT</b></p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_HASH = 2;
/**
* <p>The default (Jenkins one-at-a-time) item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_DEFAULT = 0;
/**
* <p>MD5 item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_MD5 = 1;
/**
* <p>CRC item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_CRC = 2;
/**
* <p>FNV1_64 item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_FNV1_64 = 3;
/**
* <p>FNV1_64A item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_FNV1A_64 = 4;
/**
* <p>FNV1_32 item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_FNV1_32 = 5;
/**
* <p>FNV1_32A item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_FNV1A_32 = 6;
/**
* <p>Hsieh item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_HSIEH = 7;
/**
* <p>Murmur item key hashing algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const HASH_MURMUR = 8;
/**
* <p>Specifies the method of distributing item keys to the servers.
* Currently supported methods are modulo and consistent hashing. Consistent
* hashing delivers better distribution and allows servers to be added to
* the cluster with minimal cache losses.</p>
* <p>Type: integer, default: <b>Memcached::DISTRIBUTION_MODULA.</b></p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_DISTRIBUTION = 9;
/**
* <p>Modulo-based key distribution algorithm.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const DISTRIBUTION_MODULA = 0;
/**
* <p>Consistent hashing key distribution algorithm (based on libketama).</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const DISTRIBUTION_CONSISTENT = 1;
const DISTRIBUTION_VIRTUAL_BUCKET = 6;
/**
* <p>Enables or disables compatibility with libketama-like behavior. When
* enabled, the item key hashing algorithm is set to MD5 and distribution is
* set to be weighted consistent hashing distribution. This is useful
* because other libketama-based clients (Python, Ruby, etc.) with the same
* server configuration will be able to access the keys transparently.
* </p>
* <p>
* It is highly recommended to enable this option if you want to use
* consistent hashing, and it may be enabled by default in future
* releases.
* </p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_LIBKETAMA_COMPATIBLE = 16;
const OPT_LIBKETAMA_HASH = 17;
const OPT_TCP_KEEPALIVE = 32;
/**
* <p>Enables or disables buffered I/O. Enabling buffered I/O causes
* storage commands to "buffer" instead of being sent. Any action that
* retrieves data causes this buffer to be sent to the remote connection.
* Quitting the connection or closing down the connection will also cause
* the buffered data to be pushed to the remote connection.</p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_BUFFER_WRITES = 10;
/**
* <p>Enable the use of the binary protocol. Please note that you cannot
* toggle this option on an open connection.</p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_BINARY_PROTOCOL = 18;
/**
* <p>Enables or disables asynchronous I/O. This is the fastest transport
* available for storage functions.</p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_NO_BLOCK = 0;
/**
* <p>Enables or disables the no-delay feature for connecting sockets (may
* be faster in some environments).</p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_TCP_NODELAY = 1;
/**
* <p>The maximum socket send buffer in bytes.</p>
* <p>Type: integer, default: varies by platform/kernel
* configuration.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_SOCKET_SEND_SIZE = 4;
/**
* <p>The maximum socket receive buffer in bytes.</p>
* <p>Type: integer, default: varies by platform/kernel
* configuration.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_SOCKET_RECV_SIZE = 5;
/**
* <p>In non-blocking mode this set the value of the timeout during socket
* connection, in milliseconds.</p>
* <p>Type: integer, default: 1000.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_CONNECT_TIMEOUT = 14;
/**
* <p>The amount of time, in seconds, to wait until retrying a failed
* connection attempt.</p>
* <p>Type: integer, default: 0.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_RETRY_TIMEOUT = 15;
const OPT_DEAD_TIMEOUT = 36;
/**
* <p>Socket sending timeout, in microseconds. In cases where you cannot
* use non-blocking I/O this will allow you to still have timeouts on the
* sending of data.</p>
* <p>Type: integer, default: 0.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_SEND_TIMEOUT = 19;
/**
* <p>Socket reading timeout, in microseconds. In cases where you cannot
* use non-blocking I/O this will allow you to still have timeouts on the
* reading of data.</p>
* <p>Type: integer, default: 0.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_RECV_TIMEOUT = 20;
/**
* <p>Timeout for connection polling, in milliseconds.</p>
* <p>Type: integer, default: 1000.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_POLL_TIMEOUT = 8;
/**
* <p>Enables or disables caching of DNS lookups.</p>
* <p>Type: boolean, default: <b>FALSE</b>.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_CACHE_LOOKUPS = 6;
/**
* <p>Specifies the failure limit for server connection attempts. The
* server will be removed after this many continuous connection
* failures.</p>
* <p>Type: integer, default: 0.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const OPT_SERVER_FAILURE_LIMIT = 21;
const OPT_AUTO_EJECT_HOSTS = 28;
const OPT_HASH_WITH_PREFIX_KEY = 25;
const OPT_NOREPLY = 26;
const OPT_SORT_HOSTS = 12;
const OPT_VERIFY_KEY = 13;
const OPT_USE_UDP = 27;
const OPT_NUMBER_OF_REPLICAS = 29;
const OPT_RANDOMIZE_REPLICA_READ = 30;
const OPT_REMOVE_FAILED_SERVERS = 35;
const OPT_SERVER_TIMEOUT_LIMIT = 37;
/**
* <p>The operation was successful.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_SUCCESS = 0;
/**
* <p>The operation failed in some fashion.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_FAILURE = 1;
/**
* <p>DNS lookup failed.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_HOST_LOOKUP_FAILURE = 2;
/**
* <p>Failed to read network data.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_UNKNOWN_READ_FAILURE = 7;
/**
* <p>Bad command in memcached protocol.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_PROTOCOL_ERROR = 8;
/**
* <p>Error on the client side.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_CLIENT_ERROR = 9;
/**
* <p>Error on the server side.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_SERVER_ERROR = 10;
/**
* <p>Failed to write network data.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_WRITE_FAILURE = 5;
/**
* <p>Failed to do compare-and-swap: item you are trying to store has been
* modified since you last fetched it.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_DATA_EXISTS = 12;
/**
* <p>Item was not stored: but not because of an error. This normally
* means that either the condition for an "add" or a "replace" command
* wasn't met, or that the item is in a delete queue.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_NOTSTORED = 14;
/**
* <p>Item with this key was not found (with "get" operation or "cas"
* operations).</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_NOTFOUND = 16;
/**
* <p>Partial network data read error.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_PARTIAL_READ = 18;
/**
* <p>Some errors occurred during multi-get.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_SOME_ERRORS = 19;
/**
* <p>Server list is empty.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_NO_SERVERS = 20;
/**
* <p>End of result set.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_END = 21;
/**
* <p>System error.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_ERRNO = 26;
/**
* <p>The operation was buffered.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_BUFFERED = 32;
/**
* <p>The operation timed out.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_TIMEOUT = 31;
/**
* <p>Bad key.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_BAD_KEY_PROVIDED = 33;
const RES_STORED = 15;
const RES_DELETED = 22;
const RES_STAT = 24;
const RES_ITEM = 25;
const RES_NOT_SUPPORTED = 28;
const RES_FETCH_NOTFINISHED = 30;
const RES_SERVER_MARKED_DEAD = 35;
const RES_UNKNOWN_STAT_KEY = 36;
const RES_INVALID_HOST_PROTOCOL = 34;
const RES_MEMORY_ALLOCATION_FAILURE = 17;
/**
* <p>Failed to create network socket.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_CONNECTION_SOCKET_CREATE_FAILURE = 11;
const RES_E2BIG = 37;
const RES_KEY_TOO_BIG = 39;
const RES_SERVER_TEMPORARILY_DISABLED = 47;
const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 48;
const RES_AUTH_PROBLEM = 40;
const RES_AUTH_FAILURE = 41;
const RES_AUTH_CONTINUE = 42;
/**
* <p>Payload failure: could not compress/decompress or serialize/unserialize the value.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const RES_PAYLOAD_FAILURE = -1001;
/**
* <p>The default PHP serializer.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const SERIALIZER_PHP = 1;
/**
* <p>The igbinary serializer.
* Instead of textual representation it stores PHP data structures in a
* compact binary form, resulting in space and time gains.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const SERIALIZER_IGBINARY = 2;
/**
* <p>The JSON serializer. Requires PHP 5.2.10+.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const SERIALIZER_JSON = 3;
const SERIALIZER_JSON_ARRAY = 4;
const SERIALIZER_MSGPACK = 5;
const COMPRESSION_FASTLZ = 2;
const COMPRESSION_ZLIB = 1;
/**
* <p>A flag for <b>Memcached::getMulti</b> and
* <b>Memcached::getMultiByKey</b> to ensure that the keys are
* returned in the same order as they were requested in. Non-existing keys
* get a default value of NULL.</p>
* @link http://php.net/manual/en/memcached.constants.php
*/
const GET_PRESERVE_ORDER = 1;
const GET_ERROR_RETURN_VALUE = false;
/**
* (PECL memcached >= 0.1.0)<br/>
* Create a Memcached instance
* @link http://php.net/manual/en/memcached.construct.php
* @param string $persistent_id [optional] <p>
* By default the Memcached instances are destroyed at the end of the
* request. To create an instance that persists between requests, use
* <i>persistent_id</i> to specify a unique ID for the
* instance. All instances created with the same
* <i>persistent_id</i> will share the same connection.
* </p>
*/
public function __construct ($persistent_id = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Return the result code of the last operation
* @link http://php.net/manual/en/memcached.getresultcode.php
* @return int Result code of the last Memcached operation.
*/
public function getResultCode () {}
/**
* (PECL memcached >= 1.0.0)<br/>
* Return the message describing the result of the last operation
* @link http://php.net/manual/en/memcached.getresultmessage.php
* @return string Message describing the result of the last Memcached operation.
*/
public function getResultMessage () {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Retrieve an item
* @link http://php.net/manual/en/memcached.get.php
* @param string $key <p>
* The key of the item to retrieve.
* </p>
* @param callable $cache_cb [optional] <p>
* Read-through caching callback or <b>NULL</b>.
* </p>
* @param float $cas_token [optional] <p>
* The variable to store the CAS token in.
* </p>
* @return mixed the value stored in the cache or <b>FALSE</b> otherwise.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTFOUND</b> if the key does not exist.
*/
public function get ($key, callable $cache_cb = null, &$cas_token = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Retrieve an item from a specific server
* @link http://php.net/manual/en/memcached.getbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key of the item to fetch.
* </p>
* @param callable $cache_cb [optional] <p>
* Read-through caching callback or <b>NULL</b>
* </p>
* @param float $cas_token [optional] <p>
* The variable to store the CAS token in.
* </p>
* @return mixed the value stored in the cache or <b>FALSE</b> otherwise.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTFOUND</b> if the key does not exist.
*/
public function getByKey ($server_key, $key, callable $cache_cb = null, &$cas_token = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Retrieve multiple items
* @link http://php.net/manual/en/memcached.getmulti.php
* @param array $keys <p>
* Array of keys to retrieve.
* </p>
* @param array $cas_tokens [optional] <p>
* The variable to store the CAS tokens for the found items.
* </p>
* @param int $flags [optional] <p>
* The flags for the get operation.
* </p>
* @return mixed the array of found items or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function getMulti (array $keys, array &$cas_tokens = null, $flags = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Retrieve multiple items from a specific server
* @link http://php.net/manual/en/memcached.getmultibykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param array $keys <p>
* Array of keys to retrieve.
* </p>
* @param string $cas_tokens [optional] <p>
* The variable to store the CAS tokens for the found items.
* </p>
* @param int $flags [optional] <p>
* The flags for the get operation.
* </p>
* @return array the array of found items or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function getMultiByKey ($server_key, array $keys, &$cas_tokens = null, $flags = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Request multiple items
* @link http://php.net/manual/en/memcached.getdelayed.php
* @param array $keys <p>
* Array of keys to request.
* </p>
* @param bool $with_cas [optional] <p>
* Whether to request CAS token values also.
* </p>
* @param callable $value_cb [optional] <p>
* The result callback or <b>NULL</b>.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function getDelayed (array $keys, $with_cas = null, callable $value_cb = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Request multiple items from a specific server
* @link http://php.net/manual/en/memcached.getdelayedbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param array $keys <p>
* Array of keys to request.
* </p>
* @param bool $with_cas [optional] <p>
* Whether to request CAS token values also.
* </p>
* @param callable $value_cb [optional] <p>
* The result callback or <b>NULL</b>.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function getDelayedByKey ($server_key, array $keys, $with_cas = null, callable $value_cb = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Fetch the next result
* @link http://php.net/manual/en/memcached.fetch.php
* @return array the next result or <b>FALSE</b> otherwise.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_END</b> if result set is exhausted.
*/
public function fetch () {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Fetch all the remaining results
* @link http://php.net/manual/en/memcached.fetchall.php
* @return array the results or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function fetchAll () {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Store an item
* @link http://php.net/manual/en/memcached.set.php
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function set ($key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Store an item on a specific server
* @link http://php.net/manual/en/memcached.setbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function setByKey ($server_key, $key, $value, $expiration = null) {}
/**
* (PECL memcached >= 2.0.0)<br/>
* Set a new expiration on an item
* @link http://php.net/manual/en/memcached.touch.php
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param int $expiration <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function touch ($key, $expiration) {}
/**
* (PECL memcached >= 2.0.0)<br/>
* Set a new expiration on an item on a specific server
* @link http://php.net/manual/en/memcached.touchbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param int $expiration <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function touchByKey ($server_key, $key, $expiration) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Store multiple items
* @link http://php.net/manual/en/memcached.setmulti.php
* @param array $items <p>
* An array of key/value pairs to store on the server.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function setMulti (array $items, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Store multiple items on a specific server
* @link http://php.net/manual/en/memcached.setmultibykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param array $items <p>
* An array of key/value pairs to store on the server.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* Use <b>Memcached::getResultCode</b> if necessary.
*/
public function setMultiByKey ($server_key, array $items, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Compare and swap an item
* @link http://php.net/manual/en/memcached.cas.php
* @param float $cas_token <p>
* Unique value associated with the existing item. Generated by memcache.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_DATA_EXISTS</b> if the item you are trying
* to store has been modified since you last fetched it.
*/
public function cas ($cas_token, $key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Compare and swap an item on a specific server
* @link http://php.net/manual/en/memcached.casbykey.php
* @param float $cas_token <p>
* Unique value associated with the existing item. Generated by memcache.
* </p>
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_DATA_EXISTS</b> if the item you are trying
* to store has been modified since you last fetched it.
*/
public function casByKey ($cas_token, $server_key, $key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Add an item under a new key
* @link http://php.net/manual/en/memcached.add.php
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key already exists.
*/
public function add ($key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Add an item under a new key on a specific server
* @link http://php.net/manual/en/memcached.addbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key already exists.
*/
public function addByKey ($server_key, $key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Append data to an existing item
* @link http://php.net/manual/en/memcached.append.php
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param string $value <p>
* The string to append.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function append ($key, $value) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Append data to an existing item on a specific server
* @link http://php.net/manual/en/memcached.appendbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param string $value <p>
* The string to append.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function appendByKey ($server_key, $key, $value) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Prepend data to an existing item
* @link http://php.net/manual/en/memcached.prepend.php
* @param string $key <p>
* The key of the item to prepend the data to.
* </p>
* @param string $value <p>
* The string to prepend.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function prepend ($key, $value) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Prepend data to an existing item on a specific server
* @link http://php.net/manual/en/memcached.prependbykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key of the item to prepend the data to.
* </p>
* @param string $value <p>
* The string to prepend.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function prependByKey ($server_key, $key, $value) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Replace the item under an existing key
* @link http://php.net/manual/en/memcached.replace.php
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function replace ($key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Replace the item under an existing key on a specific server
* @link http://php.net/manual/en/memcached.replacebykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key under which to store the value.
* </p>
* @param mixed $value <p>
* The value to store.
* </p>
* @param int $expiration [optional] <p>
* The expiration time, defaults to 0. See Expiration Times for more info.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTSTORED</b> if the key does not exist.
*/
public function replaceByKey ($server_key, $key, $value, $expiration = null) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Delete an item
* @link http://php.net/manual/en/memcached.delete.php
* @param string $key <p>
* The key to be deleted.
* </p>
* @param int $time [optional] <p>
* The amount of time the server will wait to delete the item.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTFOUND</b> if the key does not exist.
*/
public function delete ($key, $time = 0) {}
/**
* (PECL memcached >= 2.0.0)<br/>
* Delete multiple items
* @link http://php.net/manual/en/memcached.deletemulti.php
* @param array $keys <p>
* The keys to be deleted.
* </p>
* @param int $time [optional] <p>
* The amount of time the server will wait to delete the items.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTFOUND</b> if the key does not exist.
*/
public function deleteMulti (array $keys, $time = 0) {}
/**
* (PECL memcached >= 0.1.0)<br/>
* Delete an item from a specific server
* @link http://php.net/manual/en/memcached.deletebykey.php
* @param string $server_key <p>
* The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
* </p>
* @param string $key <p>
* The key to be deleted.
* </p>
* @param int $time [optional] <p>
* The amount of time the server will wait to delete the item.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
* The <b>Memcached::getResultCode</b> will return
* <b>Memcached::RES_NOTFOUND</b> if the key does not exist.
*/
public function deleteByKey ($server_key, $key, $time = 0) {}
/**
* (PECL memcached >= 2.0.0)<br/>
* Delete multiple items from a specific server