Standardise wording of verbs relating to revision deletion
[lhc/web/wiklou.git] / includes / objectcache / WinCacheBagOStuff.php
1 <?php
2 /**
3 * Object caching using WinCache.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Cache
22 */
23
24 /**
25 * Wrapper for WinCache object caching functions; identical interface
26 * to the APC wrapper
27 *
28 * @ingroup Cache
29 */
30 class WinCacheBagOStuff extends BagOStuff {
31
32 /**
33 * Get a value from the WinCache object cache
34 *
35 * @param string $key cache key
36 * @param $casToken[optional] int: cas token
37 * @return mixed
38 */
39 public function get( $key, &$casToken = null ) {
40 $val = wincache_ucache_get( $key );
41
42 $casToken = $val;
43
44 if ( is_string( $val ) ) {
45 $val = unserialize( $val );
46 }
47
48 return $val;
49 }
50
51 /**
52 * Store a value in the WinCache object cache
53 *
54 * @param string $key cache key
55 * @param $value Mixed: object to store
56 * @param int $expire expiration time
57 * @return bool
58 */
59 public function set( $key, $value, $expire = 0 ) {
60 $result = wincache_ucache_set( $key, serialize( $value ), $expire );
61
62 /* wincache_ucache_set returns an empty array on success if $value
63 was an array, bool otherwise */
64 return ( is_array( $result ) && $result === array() ) || $result;
65 }
66
67 /**
68 * Store a value in the WinCache object cache, race condition-safe
69 *
70 * @param int $casToken cas token
71 * @param string $key cache key
72 * @param int $value object to store
73 * @param int $exptime expiration time
74 * @return bool
75 */
76 public function cas( $casToken, $key, $value, $exptime = 0 ) {
77 return wincache_ucache_cas( $key, $casToken, serialize( $value ) );
78 }
79
80 /**
81 * Remove a value from the WinCache object cache
82 *
83 * @param string $key cache key
84 * @param int $time not used in this implementation
85 * @return bool
86 */
87 public function delete( $key, $time = 0 ) {
88 wincache_ucache_delete( $key );
89
90 return true;
91 }
92 }