paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / Cache / Handlers / PredisHandler.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 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Cache\Handlers; use CodeIgniter\Cache\CacheInterface; use CodeIgniter\Exceptions\CriticalError; /** * Predis cache handler */ class PredisHandler implements CacheInterface { /** * Prefixed to all cache names. * * @var string */ protected $prefix; /** * Default config * * @var array */ protected $config = [ 'scheme' => 'tcp', 'host' => '127.0.0.1', 'password' => null, 'port' => 6379, 'timeout' => 0, ]; /** * Predis connection * * @var \Predis\Client */ protected $redis; //-------------------------------------------------------------------- /** * Constructor. * * @param \Config\Cache $config */ public function __construct($config) { $this->prefix = $config->prefix ?: ''; if (isset($config->redis)) { $this->config = array_merge($this->config, $config->redis); } } //-------------------------------------------------------------------- /** * Takes care of any handler-specific setup that must be done. */ public function initialize() { // Try to connect to Redis, if an issue occurs throw a CriticalError exception, // so that the CacheFactory can attempt to initiate the next cache handler. try { // Create a new instance of Predis\Client $this->redis = new \Predis\Client($this->config, ['prefix' => $this->prefix]); // Check if the connection is valid by trying to get the time. $this->redis->time(); } catch (\Exception $e) { // thrown if can't connect to redis server. throw new CriticalError('Cache: Predis connection refused (' . $e->getMessage() . ').'); } } //-------------------------------------------------------------------- /** * Attempts to fetch an item from the cache store. * * @param string $key Cache item name * * @return mixed */ public function get(string $key) { $data = array_combine([ '__ci_type', '__ci_value', ], $this->redis->hmget($key, ['__ci_type', '__ci_value']) ); if (! isset($data['__ci_type'], $data['__ci_value']) || $data['__ci_value'] === false) { return null; } switch ($data['__ci_type']) { case 'array': case 'object': return unserialize($data['__ci_value']); case 'boolean': case 'integer': case 'double': // Yes, 'double' is returned and NOT 'float' case 'string': case 'NULL': return settype($data['__ci_value'], $data['__ci_type']) ? $data['__ci_value'] : null; case 'resource': default: return null; } } //-------------------------------------------------------------------- /** * Saves an item to the cache store. * * @param string $key Cache item name * @param mixed $value The data to save * @param integer $ttl Time To Live, in seconds (default 60) * * @return mixed */ public function save(string $key, $value, int $ttl = 60) { switch ($data_type = gettype($value)) { case 'array': case 'object': $value = serialize($value); break; case 'boolean': case 'integer': case 'double': // Yes, 'double' is returned and NOT 'float' case 'string': case 'NULL': break; case 'resource': default: return false; } if (! $this->redis->hmset($key, ['__ci_type' => $data_type, '__ci_value' => $value])) { return false; } $this->redis->expireat($key, time() + $ttl); return true; } //-------------------------------------------------------------------- /** * Deletes a specific item from the cache store. * * @param string $key Cache item name * * @return boolean */ public function delete(string $key) { return ($this->redis->del($key) === 1); } //-------------------------------------------------------------------- /** * Performs atomic incrementation of a raw stored value. * * @param string $key Cache ID * @param integer $offset Step/value to increase by * * @return mixed */ public function increment(string $key, int $offset = 1) { return $this->redis->hincrby($key, 'data', $offset); } //-------------------------------------------------------------------- /** * Performs atomic decrementation of a raw stored value. * * @param string $key Cache ID * @param integer $offset Step/value to increase by * * @return mixed */ public function decrement(string $key, int $offset = 1) { return $this->redis->hincrby($key, 'data', -$offset); } //-------------------------------------------------------------------- /** * Will delete all items in the entire cache. * * @return boolean */ public function clean() { return $this->redis->flushdb()->getPayload() === 'OK'; } //-------------------------------------------------------------------- /** * Returns information on the entire cache. * * The information returned and the structure of the data * varies depending on the handler. * * @return mixed */ public function getCacheInfo() { return $this->redis->info(); } //-------------------------------------------------------------------- /** * Returns detailed information about the specific item in the cache. * * @param string $key Cache item name. * * @return mixed */ public function getMetaData(string $key) { $data = array_combine(['__ci_value'], $this->redis->hmget($key, ['__ci_value'])); if (isset($data['__ci_value']) && $data['__ci_value'] !== false) { $time = time(); return [ 'expire' => $time + $this->redis->ttl($key), 'mtime' => $time, 'data' => $data['__ci_value'], ]; } return null; } //-------------------------------------------------------------------- /** * Determines if the driver is supported on this system. * * @return boolean */ public function isSupported(): bool { return class_exists('\Predis\Client'); } } |
Commits for paulgoughbooks_old/trunk/system/Cache/Handlers/PredisHandler.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |