3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009, StatusNet, Inc.
6 * Plugin to implement cache interface for APC variable cache
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Evan Prodromou <evan@status.net>
26 * @copyright 2009 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * A plugin to use APC's variable cache for the cache interface
40 * New plugin interface lets us use alternative cache systems
41 * for caching. This one uses APC's variable cache.
45 * @author Evan Prodromou <evan@status.net>
46 * @copyright 2009 StatusNet, Inc.
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
51 class APCPlugin extends Plugin
54 * Get a value associated with a key
56 * The value should have been set previously.
58 * @param string &$key in; Lookup key
59 * @param mixed &$value out; value associated with key
61 * @return boolean hook success
64 function onStartCacheGet(&$key, &$value)
66 $value = apc_fetch($key);
67 Event::handle('EndCacheGet', array($key, &$value));
72 * Associate a value with a key
74 * @param string &$key in; Key to use for lookups
75 * @param mixed &$value in; Value to associate
76 * @param integer &$flag in; Flag (passed through to Memcache)
77 * @param integer &$expiry in; Expiry (passed through to Memcache)
78 * @param boolean &$success out; Whether the set was successful
80 * @return boolean hook success
83 function onStartCacheSet(&$key, &$value, &$flag, &$expiry, &$success)
85 $success = apc_store($key, $value, ((is_null($expiry)) ? 0 : $expiry));
87 Event::handle('EndCacheSet', array($key, $value, $flag,
93 * Delete a value associated with a key
95 * @param string &$key in; Key to lookup
96 * @param boolean &$success out; whether it worked
98 * @return boolean hook success
101 function onStartCacheDelete(&$key, &$success)
103 $success = apc_delete($key);
104 Event::handle('EndCacheDelete', array($key));
108 function onPluginVersion(&$versions)
110 $versions[] = array('name' => 'APC',
111 'version' => STATUSNET_VERSION,
112 'author' => 'Evan Prodromou',
113 'homepage' => 'http://status.net/wiki/Plugin:APC',
115 _m('Use the <a href="http://pecl.php.net/package/apc">APC</a> variable cache to cache query results.'));