@@ -22,47 +22,47 @@ discard block |
||
| 22 | 22 | final class Cacheer implements CacheerInterface |
| 23 | 23 | { |
| 24 | 24 | /** |
| 25 | - * @var string |
|
| 26 | - */ |
|
| 25 | + * @var string |
|
| 26 | + */ |
|
| 27 | 27 | private string $message; |
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | - * @var boolean |
|
| 31 | - */ |
|
| 30 | + * @var boolean |
|
| 31 | + */ |
|
| 32 | 32 | private bool $success; |
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | - * @var boolean |
|
| 36 | - */ |
|
| 35 | + * @var boolean |
|
| 36 | + */ |
|
| 37 | 37 | private bool $formatted = false; |
| 38 | 38 | |
| 39 | 39 | /** |
| 40 | - * @var bool |
|
| 41 | - */ |
|
| 40 | + * @var bool |
|
| 41 | + */ |
|
| 42 | 42 | private bool $compression = false; |
| 43 | 43 | |
| 44 | 44 | /** |
| 45 | - * @var string|null |
|
| 46 | - */ |
|
| 45 | + * @var string|null |
|
| 46 | + */ |
|
| 47 | 47 | private ?string $encryptionKey = null; |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | - * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore |
|
| 51 | - */ |
|
| 50 | + * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore |
|
| 51 | + */ |
|
| 52 | 52 | public $cacheStore; |
| 53 | 53 | |
| 54 | 54 | /** |
| 55 | - * @var array |
|
| 56 | - */ |
|
| 55 | + * @var array |
|
| 56 | + */ |
|
| 57 | 57 | public array $options = []; |
| 58 | 58 | |
| 59 | 59 | /** |
| 60 | - * Cacheer constructor. |
|
| 61 | - * |
|
| 62 | - * @param array $options |
|
| 63 | - * @param bool $formatted |
|
| 64 | - * @throws RuntimeException |
|
| 65 | - */ |
|
| 60 | + * Cacheer constructor. |
|
| 61 | + * |
|
| 62 | + * @param array $options |
|
| 63 | + * @param bool $formatted |
|
| 64 | + * @throws RuntimeException |
|
| 65 | + */ |
|
| 66 | 66 | public function __construct(array $options = [], $formatted = false) |
| 67 | 67 | { |
| 68 | 68 | $this->formatted = $formatted; |
@@ -71,14 +71,14 @@ discard block |
||
| 71 | 71 | } |
| 72 | 72 | |
| 73 | 73 | /** |
| 74 | - * Adds data to the cache if it does not already exist. |
|
| 75 | - * |
|
| 76 | - * @param string $cacheKey |
|
| 77 | - * @param mixed $cacheData |
|
| 78 | - * @param string $namespace |
|
| 79 | - * @param int|string $ttl |
|
| 80 | - * @return bool |
|
| 81 | - */ |
|
| 74 | + * Adds data to the cache if it does not already exist. |
|
| 75 | + * |
|
| 76 | + * @param string $cacheKey |
|
| 77 | + * @param mixed $cacheData |
|
| 78 | + * @param string $namespace |
|
| 79 | + * @param int|string $ttl |
|
| 80 | + * @return bool |
|
| 81 | + */ |
|
| 82 | 82 | public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600) |
| 83 | 83 | { |
| 84 | 84 | if (!empty($this->getCache($cacheKey, $namespace))) { |
@@ -92,13 +92,13 @@ discard block |
||
| 92 | 92 | } |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | - * Appends data to an existing cache item. |
|
| 96 | - * |
|
| 97 | - * @param string $cacheKey |
|
| 98 | - * @param mixed $cacheData |
|
| 99 | - * @param string $namespace |
|
| 100 | - * @return void |
|
| 101 | - */ |
|
| 95 | + * Appends data to an existing cache item. |
|
| 96 | + * |
|
| 97 | + * @param string $cacheKey |
|
| 98 | + * @param mixed $cacheData |
|
| 99 | + * @param string $namespace |
|
| 100 | + * @return void |
|
| 101 | + */ |
|
| 102 | 102 | public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '') |
| 103 | 103 | { |
| 104 | 104 | $this->cacheStore->appendCache($cacheKey, $cacheData, $namespace); |
@@ -106,12 +106,12 @@ discard block |
||
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | /** |
| 109 | - * Clears a specific cache item. |
|
| 110 | - * |
|
| 111 | - * @param string $cacheKey |
|
| 112 | - * @param string $namespace |
|
| 113 | - * @return void |
|
| 114 | - */ |
|
| 109 | + * Clears a specific cache item. |
|
| 110 | + * |
|
| 111 | + * @param string $cacheKey |
|
| 112 | + * @param string $namespace |
|
| 113 | + * @return void |
|
| 114 | + */ |
|
| 115 | 115 | public function clearCache(string $cacheKey, string $namespace = '') |
| 116 | 116 | { |
| 117 | 117 | $this->cacheStore->clearCache($cacheKey, $namespace); |
@@ -119,25 +119,25 @@ discard block |
||
| 119 | 119 | } |
| 120 | 120 | |
| 121 | 121 | /** |
| 122 | - * Decrements a cache item by a specified amount. |
|
| 123 | - * |
|
| 124 | - * @param string $cacheKey |
|
| 125 | - * @param int $amount |
|
| 126 | - * @param string $namespace |
|
| 127 | - * @return bool |
|
| 128 | - */ |
|
| 122 | + * Decrements a cache item by a specified amount. |
|
| 123 | + * |
|
| 124 | + * @param string $cacheKey |
|
| 125 | + * @param int $amount |
|
| 126 | + * @param string $namespace |
|
| 127 | + * @return bool |
|
| 128 | + */ |
|
| 129 | 129 | public function decrement(string $cacheKey, int $amount = 1, string $namespace = '') |
| 130 | 130 | { |
| 131 | 131 | return $this->increment($cacheKey, ($amount * -1), $namespace); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | - * Store data in the cache permanently. |
|
| 136 | - * |
|
| 137 | - * @param string $cacheKey |
|
| 138 | - * @param mixed $cacheData |
|
| 139 | - * @return void |
|
| 140 | - */ |
|
| 135 | + * Store data in the cache permanently. |
|
| 136 | + * |
|
| 137 | + * @param string $cacheKey |
|
| 138 | + * @param mixed $cacheData |
|
| 139 | + * @return void |
|
| 140 | + */ |
|
| 141 | 141 | public function forever(string $cacheKey, mixed $cacheData) |
| 142 | 142 | { |
| 143 | 143 | $this->putCache($cacheKey, $cacheData, ttl: 31536000 * 1000); |
@@ -145,10 +145,10 @@ discard block |
||
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | /** |
| 148 | - * Flushes all cache items. |
|
| 149 | - * |
|
| 150 | - * @return void |
|
| 151 | - */ |
|
| 148 | + * Flushes all cache items. |
|
| 149 | + * |
|
| 150 | + * @return void |
|
| 151 | + */ |
|
| 152 | 152 | public function flushCache() |
| 153 | 153 | { |
| 154 | 154 | $this->cacheStore->flushCache(); |
@@ -156,12 +156,12 @@ discard block |
||
| 156 | 156 | } |
| 157 | 157 | |
| 158 | 158 | /** |
| 159 | - * Retrieves a cache item and deletes it from the cache. |
|
| 160 | - * |
|
| 161 | - * @param string $cacheKey |
|
| 162 | - * @param string $namespace |
|
| 163 | - * @return mixed |
|
| 164 | - */ |
|
| 159 | + * Retrieves a cache item and deletes it from the cache. |
|
| 160 | + * |
|
| 161 | + * @param string $cacheKey |
|
| 162 | + * @param string $namespace |
|
| 163 | + * @return mixed |
|
| 164 | + */ |
|
| 165 | 165 | public function getAndForget(string $cacheKey, string $namespace = '') |
| 166 | 166 | { |
| 167 | 167 | $cachedData = $this->getCache($cacheKey, $namespace); |
@@ -176,11 +176,11 @@ discard block |
||
| 176 | 176 | } |
| 177 | 177 | |
| 178 | 178 | /** |
| 179 | - * Gets all items in a specific namespace. |
|
| 180 | - * |
|
| 181 | - * @param string $namespace |
|
| 182 | - * @return CacheDataFormatter|array |
|
| 183 | - */ |
|
| 179 | + * Gets all items in a specific namespace. |
|
| 180 | + * |
|
| 181 | + * @param string $namespace |
|
| 182 | + * @return CacheDataFormatter|array |
|
| 183 | + */ |
|
| 184 | 184 | public function getAll(string $namespace = '') |
| 185 | 185 | { |
| 186 | 186 | $cachedData = $this->cacheStore->getAll($namespace); |
@@ -196,13 +196,13 @@ discard block |
||
| 196 | 196 | } |
| 197 | 197 | |
| 198 | 198 | /** |
| 199 | - * Retrieves a single cache item. |
|
| 200 | - * |
|
| 201 | - * @param string $cacheKey |
|
| 202 | - * @param string $namespace |
|
| 203 | - * @param string|int $ttl |
|
| 204 | - * @return CacheDataFormatter|mixed |
|
| 205 | - */ |
|
| 199 | + * Retrieves a single cache item. |
|
| 200 | + * |
|
| 201 | + * @param string $cacheKey |
|
| 202 | + * @param string $namespace |
|
| 203 | + * @param string|int $ttl |
|
| 204 | + * @return CacheDataFormatter|mixed |
|
| 205 | + */ |
|
| 206 | 206 | public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600) |
| 207 | 207 | { |
| 208 | 208 | $cacheData = $this->cacheStore->getCache($cacheKey, $namespace, $ttl); |
@@ -216,13 +216,13 @@ discard block |
||
| 216 | 216 | } |
| 217 | 217 | |
| 218 | 218 | /** |
| 219 | - * Retrieves multiple cache items by their keys. |
|
| 220 | - * |
|
| 221 | - * @param array $cacheKeys |
|
| 222 | - * @param string $namespace |
|
| 223 | - * @param string|int $ttl |
|
| 224 | - * @return CacheDataFormatter|array |
|
| 225 | - */ |
|
| 219 | + * Retrieves multiple cache items by their keys. |
|
| 220 | + * |
|
| 221 | + * @param array $cacheKeys |
|
| 222 | + * @param string $namespace |
|
| 223 | + * @param string|int $ttl |
|
| 224 | + * @return CacheDataFormatter|array |
|
| 225 | + */ |
|
| 226 | 226 | public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600) |
| 227 | 227 | { |
| 228 | 228 | $cachedData = $this->cacheStore->getMany($cacheKeys, $namespace, $ttl); |
@@ -238,12 +238,12 @@ discard block |
||
| 238 | 238 | } |
| 239 | 239 | |
| 240 | 240 | /** |
| 241 | - * Checks if a cache item exists. |
|
| 242 | - * |
|
| 243 | - * @param string $cacheKey |
|
| 244 | - * @param string $namespace |
|
| 245 | - * @return void |
|
| 246 | - */ |
|
| 241 | + * Checks if a cache item exists. |
|
| 242 | + * |
|
| 243 | + * @param string $cacheKey |
|
| 244 | + * @param string $namespace |
|
| 245 | + * @return void |
|
| 246 | + */ |
|
| 247 | 247 | public function has(string $cacheKey, string $namespace = '') |
| 248 | 248 | { |
| 249 | 249 | $this->cacheStore->has($cacheKey, $namespace); |
@@ -251,13 +251,13 @@ discard block |
||
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | /** |
| 254 | - * Increments a cache item by a specified amount. |
|
| 255 | - * |
|
| 256 | - * @param string $cacheKey |
|
| 257 | - * @param int $amount |
|
| 258 | - * @param string $namespace |
|
| 259 | - * @return bool |
|
| 260 | - */ |
|
| 254 | + * Increments a cache item by a specified amount. |
|
| 255 | + * |
|
| 256 | + * @param string $cacheKey |
|
| 257 | + * @param int $amount |
|
| 258 | + * @param string $namespace |
|
| 259 | + * @return bool |
|
| 260 | + */ |
|
| 261 | 261 | public function increment(string $cacheKey, int $amount = 1, string $namespace = '') |
| 262 | 262 | { |
| 263 | 263 | $cacheData = $this->getCache($cacheKey, $namespace); |
@@ -272,24 +272,24 @@ discard block |
||
| 272 | 272 | } |
| 273 | 273 | |
| 274 | 274 | /** |
| 275 | - * Checks if the last operation was successful. |
|
| 276 | - * |
|
| 277 | - * @return boolean |
|
| 278 | - */ |
|
| 275 | + * Checks if the last operation was successful. |
|
| 276 | + * |
|
| 277 | + * @return boolean |
|
| 278 | + */ |
|
| 279 | 279 | public function isSuccess() |
| 280 | 280 | { |
| 281 | 281 | return $this->success; |
| 282 | 282 | } |
| 283 | 283 | |
| 284 | 284 | /** |
| 285 | - * Stores an item in the cache with a specific TTL. |
|
| 286 | - * |
|
| 287 | - * @param string $cacheKey |
|
| 288 | - * @param mixed $cacheData |
|
| 289 | - * @param string $namespace |
|
| 290 | - * @param string|int $ttl |
|
| 291 | - * @return void |
|
| 292 | - */ |
|
| 285 | + * Stores an item in the cache with a specific TTL. |
|
| 286 | + * |
|
| 287 | + * @param string $cacheKey |
|
| 288 | + * @param mixed $cacheData |
|
| 289 | + * @param string $namespace |
|
| 290 | + * @param string|int $ttl |
|
| 291 | + * @return void |
|
| 292 | + */ |
|
| 293 | 293 | public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int $ttl = 3600) |
| 294 | 294 | { |
| 295 | 295 | $data = CacheerHelper::prepareForStorage($cacheData, $this->compression, $this->encryptionKey); |
@@ -298,26 +298,26 @@ discard block |
||
| 298 | 298 | } |
| 299 | 299 | |
| 300 | 300 | /** |
| 301 | - * Stores multiple items in the cache. |
|
| 302 | - * |
|
| 303 | - * @param array $items |
|
| 304 | - * @param string $namespace |
|
| 305 | - * @param integer $batchSize |
|
| 306 | - * @return void |
|
| 307 | - */ |
|
| 301 | + * Stores multiple items in the cache. |
|
| 302 | + * |
|
| 303 | + * @param array $items |
|
| 304 | + * @param string $namespace |
|
| 305 | + * @param integer $batchSize |
|
| 306 | + * @return void |
|
| 307 | + */ |
|
| 308 | 308 | public function putMany(array $items, string $namespace = '', int $batchSize = 100) |
| 309 | 309 | { |
| 310 | 310 | $this->cacheStore->putMany($items, $namespace, $batchSize); |
| 311 | 311 | } |
| 312 | 312 | |
| 313 | 313 | /** |
| 314 | - * Renews the cache for a specific key with a new TTL. |
|
| 315 | - * |
|
| 316 | - * @param string $cacheKey |
|
| 317 | - * @param string|int $ttl |
|
| 318 | - * @param string $namespace |
|
| 319 | - * @return void |
|
| 320 | - */ |
|
| 314 | + * Renews the cache for a specific key with a new TTL. |
|
| 315 | + * |
|
| 316 | + * @param string $cacheKey |
|
| 317 | + * @param string|int $ttl |
|
| 318 | + * @param string $namespace |
|
| 319 | + * @return void |
|
| 320 | + */ |
|
| 321 | 321 | public function renewCache(string $cacheKey, string|int $ttl = 3600, string $namespace = '') |
| 322 | 322 | { |
| 323 | 323 | $this->cacheStore->renewCache($cacheKey, $ttl, $namespace); |
@@ -330,13 +330,13 @@ discard block |
||
| 330 | 330 | } |
| 331 | 331 | |
| 332 | 332 | /** |
| 333 | - * Retrieves a cache item or executes a callback to store it if not found. |
|
| 334 | - * |
|
| 335 | - * @param string $cacheKey |
|
| 336 | - * @param int|string $ttl |
|
| 337 | - * @param Closure $callback |
|
| 338 | - * @return mixed |
|
| 339 | - */ |
|
| 333 | + * Retrieves a cache item or executes a callback to store it if not found. |
|
| 334 | + * |
|
| 335 | + * @param string $cacheKey |
|
| 336 | + * @param int|string $ttl |
|
| 337 | + * @param Closure $callback |
|
| 338 | + * @return mixed |
|
| 339 | + */ |
|
| 340 | 340 | public function remember(string $cacheKey, int|string $ttl, Closure $callback) |
| 341 | 341 | { |
| 342 | 342 | $cachedData = $this->getCache($cacheKey, ttl: $ttl); |
@@ -353,44 +353,44 @@ discard block |
||
| 353 | 353 | } |
| 354 | 354 | |
| 355 | 355 | /** |
| 356 | - * Retrieves a cache item or executes a callback to store it permanently if not found. |
|
| 357 | - * |
|
| 358 | - * @param string $cacheKey |
|
| 359 | - * @param Closure $callback |
|
| 360 | - * @return mixed |
|
| 361 | - */ |
|
| 356 | + * Retrieves a cache item or executes a callback to store it permanently if not found. |
|
| 357 | + * |
|
| 358 | + * @param string $cacheKey |
|
| 359 | + * @param Closure $callback |
|
| 360 | + * @return mixed |
|
| 361 | + */ |
|
| 362 | 362 | public function rememberForever(string $cacheKey, Closure $callback) |
| 363 | 363 | { |
| 364 | 364 | return $this->remember($cacheKey, 31536000 * 1000, $callback); |
| 365 | 365 | } |
| 366 | 366 | |
| 367 | 367 | /** |
| 368 | - * Returns a CacheConfig instance for configuration management. |
|
| 369 | - * |
|
| 370 | - * @return CacheConfig |
|
| 371 | - */ |
|
| 368 | + * Returns a CacheConfig instance for configuration management. |
|
| 369 | + * |
|
| 370 | + * @return CacheConfig |
|
| 371 | + */ |
|
| 372 | 372 | public function setConfig() |
| 373 | 373 | { |
| 374 | 374 | return new CacheConfig($this); |
| 375 | 375 | } |
| 376 | 376 | |
| 377 | 377 | /** |
| 378 | - * Sets the cache driver based on the configuration. |
|
| 379 | - * |
|
| 380 | - * @return CacheDriver |
|
| 381 | - */ |
|
| 378 | + * Sets the cache driver based on the configuration. |
|
| 379 | + * |
|
| 380 | + * @return CacheDriver |
|
| 381 | + */ |
|
| 382 | 382 | public function setDriver() |
| 383 | 383 | { |
| 384 | 384 | return new CacheDriver($this); |
| 385 | 385 | } |
| 386 | 386 | |
| 387 | 387 | /** |
| 388 | - * Sets a message for the cache operation. |
|
| 389 | - * |
|
| 390 | - * @param string $message |
|
| 391 | - * @param boolean $success |
|
| 392 | - * @return void |
|
| 393 | - */ |
|
| 388 | + * Sets a message for the cache operation. |
|
| 389 | + * |
|
| 390 | + * @param string $message |
|
| 391 | + * @param boolean $success |
|
| 392 | + * @return void |
|
| 393 | + */ |
|
| 394 | 394 | private function setMessage(string $message, bool $success) |
| 395 | 395 | { |
| 396 | 396 | $this->message = $message; |
@@ -398,42 +398,42 @@ discard block |
||
| 398 | 398 | } |
| 399 | 399 | |
| 400 | 400 | /** |
| 401 | - * Retrieves the message from the last operation. |
|
| 402 | - * |
|
| 403 | - * @return string |
|
| 404 | - */ |
|
| 401 | + * Retrieves the message from the last operation. |
|
| 402 | + * |
|
| 403 | + * @return string |
|
| 404 | + */ |
|
| 405 | 405 | public function getMessage() |
| 406 | 406 | { |
| 407 | 407 | return $this->message; |
| 408 | 408 | } |
| 409 | 409 | |
| 410 | 410 | /** |
| 411 | - * Enables or disables the formatter for cache data. |
|
| 412 | - * |
|
| 413 | - * @return void |
|
| 414 | - */ |
|
| 411 | + * Enables or disables the formatter for cache data. |
|
| 412 | + * |
|
| 413 | + * @return void |
|
| 414 | + */ |
|
| 415 | 415 | public function useFormatter() |
| 416 | 416 | { |
| 417 | 417 | $this->formatted = !$this->formatted; |
| 418 | 418 | } |
| 419 | 419 | |
| 420 | 420 | /** |
| 421 | - * Validates the options provided for the Cacheer instance. |
|
| 422 | - * |
|
| 423 | - * @param array $options |
|
| 424 | - * @return void |
|
| 425 | - */ |
|
| 421 | + * Validates the options provided for the Cacheer instance. |
|
| 422 | + * |
|
| 423 | + * @param array $options |
|
| 424 | + * @return void |
|
| 425 | + */ |
|
| 426 | 426 | private function validateOptions(array $options) |
| 427 | 427 | { |
| 428 | 428 | $this->options = $options; |
| 429 | 429 | } |
| 430 | 430 | |
| 431 | 431 | /** |
| 432 | - * Enable or disable data compression |
|
| 433 | - * |
|
| 434 | - * @param bool $status |
|
| 435 | - * @return $this |
|
| 436 | - */ |
|
| 432 | + * Enable or disable data compression |
|
| 433 | + * |
|
| 434 | + * @param bool $status |
|
| 435 | + * @return $this |
|
| 436 | + */ |
|
| 437 | 437 | public function useCompression(bool $status = true) |
| 438 | 438 | { |
| 439 | 439 | $this->compression = $status; |
@@ -441,11 +441,11 @@ discard block |
||
| 441 | 441 | } |
| 442 | 442 | |
| 443 | 443 | /** |
| 444 | - * Enable encryption for cached data |
|
| 445 | - * |
|
| 446 | - * @param string $key |
|
| 447 | - * @return $this |
|
| 448 | - */ |
|
| 444 | + * Enable encryption for cached data |
|
| 445 | + * |
|
| 446 | + * @param string $key |
|
| 447 | + * @return $this |
|
| 448 | + */ |
|
| 449 | 449 | public function useEncryption(string $key) |
| 450 | 450 | { |
| 451 | 451 | $this->encryptionKey = $key; |
@@ -13,29 +13,29 @@ discard block |
||
| 13 | 13 | class CacheRedisHelper |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * serializes or unserializes data based on the $serialize flag. |
|
| 18 | - * |
|
| 19 | - * @param mixed $data |
|
| 20 | - * @param bool $serialize |
|
| 21 | - * @return mixed |
|
| 22 | - */ |
|
| 23 | - public static function serialize(mixed $data, bool $serialize = true) |
|
| 24 | - { |
|
| 16 | + /** |
|
| 17 | + * serializes or unserializes data based on the $serialize flag. |
|
| 18 | + * |
|
| 19 | + * @param mixed $data |
|
| 20 | + * @param bool $serialize |
|
| 21 | + * @return mixed |
|
| 22 | + */ |
|
| 23 | + public static function serialize(mixed $data, bool $serialize = true) |
|
| 24 | + { |
|
| 25 | 25 | if($serialize) { |
| 26 | - return serialize($data); |
|
| 26 | + return serialize($data); |
|
| 27 | 27 | } |
| 28 | 28 | |
| 29 | 29 | return unserialize($data); |
| 30 | 30 | |
| 31 | - } |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | 33 | /** |
| 34 | - * Validates a cache item. |
|
| 35 | - * |
|
| 36 | - * @param array $item |
|
| 37 | - * @return void |
|
| 38 | - */ |
|
| 34 | + * Validates a cache item. |
|
| 35 | + * |
|
| 36 | + * @param array $item |
|
| 37 | + * @return void |
|
| 38 | + */ |
|
| 39 | 39 | public static function validateCacheItem(array $item) |
| 40 | 40 | { |
| 41 | 41 | CacheerHelper::validateCacheItem( |
@@ -45,27 +45,27 @@ discard block |
||
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | /** |
| 48 | - * Merges cache data with existing data. |
|
| 49 | - * |
|
| 50 | - * @param array $options |
|
| 51 | - * @return array |
|
| 52 | - */ |
|
| 48 | + * Merges cache data with existing data. |
|
| 49 | + * |
|
| 50 | + * @param array $options |
|
| 51 | + * @return array |
|
| 52 | + */ |
|
| 53 | 53 | public static function mergeCacheData($cacheData) |
| 54 | 54 | { |
| 55 | 55 | return CacheerHelper::mergeCacheData($cacheData); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Generates an array identifier for cache data. |
|
| 60 | - * |
|
| 61 | - * @param mixed $currentCacheData |
|
| 62 | - * @param mixed $cacheData |
|
| 63 | - * @return array |
|
| 64 | - */ |
|
| 65 | - public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData) |
|
| 66 | - { |
|
| 67 | - return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData); |
|
| 68 | - } |
|
| 58 | + /** |
|
| 59 | + * Generates an array identifier for cache data. |
|
| 60 | + * |
|
| 61 | + * @param mixed $currentCacheData |
|
| 62 | + * @param mixed $cacheData |
|
| 63 | + * @return array |
|
| 64 | + */ |
|
| 65 | + public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData) |
|
| 66 | + { |
|
| 67 | + return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | 70 | } |
| 71 | 71 | |
@@ -14,11 +14,11 @@ discard block |
||
| 14 | 14 | { |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | - * Converts a string expiration format to seconds. |
|
| 18 | - * |
|
| 19 | - * @param string $expiration |
|
| 20 | - * @return int |
|
| 21 | - */ |
|
| 17 | + * Converts a string expiration format to seconds. |
|
| 18 | + * |
|
| 19 | + * @param string $expiration |
|
| 20 | + * @return int |
|
| 21 | + */ |
|
| 22 | 22 | public static function convertExpirationToSeconds(string $expiration) |
| 23 | 23 | { |
| 24 | 24 | $units = [ |
@@ -39,11 +39,11 @@ discard block |
||
| 39 | 39 | } |
| 40 | 40 | |
| 41 | 41 | /** |
| 42 | - * Merges cache data with existing data. |
|
| 43 | - * |
|
| 44 | - * @param array $options |
|
| 45 | - * @return array |
|
| 46 | - */ |
|
| 42 | + * Merges cache data with existing data. |
|
| 43 | + * |
|
| 44 | + * @param array $options |
|
| 45 | + * @return array |
|
| 46 | + */ |
|
| 47 | 47 | public static function mergeCacheData($cacheData) |
| 48 | 48 | { |
| 49 | 49 | return CacheerHelper::mergeCacheData($cacheData); |
@@ -64,12 +64,12 @@ discard block |
||
| 64 | 64 | } |
| 65 | 65 | |
| 66 | 66 | /** |
| 67 | - * Calculates the TTL (Time To Live) for cache items. |
|
| 68 | - * |
|
| 69 | - * @param string|int $ttl |
|
| 70 | - * @param int $defaultTTL |
|
| 71 | - * @return mixed |
|
| 72 | - */ |
|
| 67 | + * Calculates the TTL (Time To Live) for cache items. |
|
| 68 | + * |
|
| 69 | + * @param string|int $ttl |
|
| 70 | + * @param int $defaultTTL |
|
| 71 | + * @return mixed |
|
| 72 | + */ |
|
| 73 | 73 | public static function ttl($ttl = null, ?int $defaultTTL = null) { |
| 74 | 74 | if ($ttl) { |
| 75 | 75 | $ttl = is_string($ttl) ? self::convertExpirationToSeconds($ttl) : $ttl; |
@@ -79,15 +79,15 @@ discard block |
||
| 79 | 79 | return $ttl; |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Generates an array identifier for cache data. |
|
| 84 | - * |
|
| 85 | - * @param mixed $currentCacheData |
|
| 86 | - * @param mixed $cacheData |
|
| 87 | - * @return array |
|
| 88 | - */ |
|
| 89 | - public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData) |
|
| 90 | - { |
|
| 82 | + /** |
|
| 83 | + * Generates an array identifier for cache data. |
|
| 84 | + * |
|
| 85 | + * @param mixed $currentCacheData |
|
| 86 | + * @param mixed $cacheData |
|
| 87 | + * @return array |
|
| 88 | + */ |
|
| 89 | + public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData) |
|
| 90 | + { |
|
| 91 | 91 | return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData); |
| 92 | - } |
|
| 92 | + } |
|
| 93 | 93 | } |
@@ -12,24 +12,24 @@ discard block |
||
| 12 | 12 | { |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | - * Gets the path to the SQLite database file. |
|
| 16 | - * |
|
| 17 | - * @param string $database |
|
| 18 | - * @param ?string $path |
|
| 19 | - * @return string |
|
| 20 | - */ |
|
| 15 | + * Gets the path to the SQLite database file. |
|
| 16 | + * |
|
| 17 | + * @param string $database |
|
| 18 | + * @param ?string $path |
|
| 19 | + * @return string |
|
| 20 | + */ |
|
| 21 | 21 | public static function database(string $database = 'database.sqlite', ?string $path = null) |
| 22 | 22 | { |
| 23 | 23 | return self::getDynamicSqliteDbPath($database, $path); |
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Gets the path to the SQLite database file dynamically. |
|
| 28 | - * |
|
| 29 | - * @param string $database |
|
| 30 | - * @param ?string $path |
|
| 31 | - * @return string |
|
| 32 | - */ |
|
| 27 | + * Gets the path to the SQLite database file dynamically. |
|
| 28 | + * |
|
| 29 | + * @param string $database |
|
| 30 | + * @param ?string $path |
|
| 31 | + * @return string |
|
| 32 | + */ |
|
| 33 | 33 | private static function getDynamicSqliteDbPath(string $database, ?string $path = null) |
| 34 | 34 | { |
| 35 | 35 | $rootPath = EnvHelper::getRootPath(); |
@@ -47,11 +47,11 @@ discard block |
||
| 47 | 47 | } |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | - * Creates the database directory if it does not exist. |
|
| 51 | - * |
|
| 52 | - * @param string $databaseDir |
|
| 53 | - * @return void |
|
| 54 | - */ |
|
| 50 | + * Creates the database directory if it does not exist. |
|
| 51 | + * |
|
| 52 | + * @param string $databaseDir |
|
| 53 | + * @return void |
|
| 54 | + */ |
|
| 55 | 55 | private static function createDatabaseDir(string $databaseDir) |
| 56 | 56 | { |
| 57 | 57 | if (!is_dir($databaseDir)) { |
@@ -60,11 +60,11 @@ discard block |
||
| 60 | 60 | } |
| 61 | 61 | |
| 62 | 62 | /** |
| 63 | - * Creates the SQLite database file if it does not exist. |
|
| 64 | - * |
|
| 65 | - * @param string $dbFile |
|
| 66 | - * @return void |
|
| 67 | - */ |
|
| 63 | + * Creates the SQLite database file if it does not exist. |
|
| 64 | + * |
|
| 65 | + * @param string $dbFile |
|
| 66 | + * @return void |
|
| 67 | + */ |
|
| 68 | 68 | private static function createDatabaseFile(string $dbFile) |
| 69 | 69 | { |
| 70 | 70 | if (!file_exists($dbFile)) { |
@@ -73,12 +73,12 @@ discard block |
||
| 73 | 73 | } |
| 74 | 74 | |
| 75 | 75 | /** |
| 76 | - * Checks if the database name has the correct extension. |
|
| 77 | - * If not, appends '.sqlite' to the name. |
|
| 78 | - * |
|
| 79 | - * @param string $database |
|
| 80 | - * @return string |
|
| 81 | - */ |
|
| 76 | + * Checks if the database name has the correct extension. |
|
| 77 | + * If not, appends '.sqlite' to the name. |
|
| 78 | + * |
|
| 79 | + * @param string $database |
|
| 80 | + * @return string |
|
| 81 | + */ |
|
| 82 | 82 | private static function checkExtension(string $database) |
| 83 | 83 | { |
| 84 | 84 | if (strpos($database, '.sqlite') === false) { |
@@ -23,61 +23,61 @@ discard block |
||
| 23 | 23 | } |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * Logs a info message. |
|
| 27 | - * |
|
| 28 | - * @return void |
|
| 29 | - */ |
|
| 26 | + * Logs a info message. |
|
| 27 | + * |
|
| 28 | + * @return void |
|
| 29 | + */ |
|
| 30 | 30 | public function info($message) |
| 31 | 31 | { |
| 32 | 32 | $this->log('INFO', $message); |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | 35 | /** |
| 36 | - * Logs a warning message. |
|
| 37 | - * |
|
| 38 | - * @return void |
|
| 39 | - */ |
|
| 36 | + * Logs a warning message. |
|
| 37 | + * |
|
| 38 | + * @return void |
|
| 39 | + */ |
|
| 40 | 40 | public function warning($message) |
| 41 | 41 | { |
| 42 | 42 | $this->log('WARNING', $message); |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | 45 | /** |
| 46 | - * Logs an error message. |
|
| 47 | - * |
|
| 48 | - * @return void |
|
| 49 | - */ |
|
| 46 | + * Logs an error message. |
|
| 47 | + * |
|
| 48 | + * @return void |
|
| 49 | + */ |
|
| 50 | 50 | public function error($message) |
| 51 | 51 | { |
| 52 | 52 | $this->log('ERROR', $message); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | /** |
| 56 | - * Logs a debug message. |
|
| 57 | - * |
|
| 58 | - * @return void |
|
| 59 | - */ |
|
| 56 | + * Logs a debug message. |
|
| 57 | + * |
|
| 58 | + * @return void |
|
| 59 | + */ |
|
| 60 | 60 | public function debug($message) |
| 61 | 61 | { |
| 62 | 62 | $this->log('DEBUG', $message); |
| 63 | 63 | } |
| 64 | 64 | |
| 65 | 65 | /** |
| 66 | - * Checks if the log level is sufficient to log the message. |
|
| 67 | - * |
|
| 68 | - * @param mixed $level |
|
| 69 | - * @return string|int|false |
|
| 70 | - */ |
|
| 66 | + * Checks if the log level is sufficient to log the message. |
|
| 67 | + * |
|
| 68 | + * @param mixed $level |
|
| 69 | + * @return string|int|false |
|
| 70 | + */ |
|
| 71 | 71 | private function shouldLog(mixed $level) |
| 72 | 72 | { |
| 73 | 73 | return array_search($level, $this->logLevels) >= array_search($this->logLevel, $this->logLevels); |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * Rotates the log file if it exceeds the maximum size. |
|
| 78 | - * |
|
| 79 | - * @return void |
|
| 80 | - */ |
|
| 77 | + * Rotates the log file if it exceeds the maximum size. |
|
| 78 | + * |
|
| 79 | + * @return void |
|
| 80 | + */ |
|
| 81 | 81 | private function rotateLog() |
| 82 | 82 | { |
| 83 | 83 | if (file_exists($this->logFile) && filesize($this->logFile) >= $this->maxFileSize) { |
@@ -87,12 +87,12 @@ discard block |
||
| 87 | 87 | } |
| 88 | 88 | |
| 89 | 89 | /** |
| 90 | - * Logs a message to the log file. |
|
| 91 | - * |
|
| 92 | - * @param mixed $level |
|
| 93 | - * @param string $message |
|
| 94 | - * @return void |
|
| 95 | - */ |
|
| 90 | + * Logs a message to the log file. |
|
| 91 | + * |
|
| 92 | + * @param mixed $level |
|
| 93 | + * @param string $message |
|
| 94 | + * @return void |
|
| 95 | + */ |
|
| 96 | 96 | private function log($level, $message) |
| 97 | 97 | { |
| 98 | 98 | if (!$this->shouldLog($level)) { |
@@ -20,8 +20,8 @@ discard block |
||
| 20 | 20 | { |
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | - * @var Cacheer |
|
| 24 | - */ |
|
| 23 | + * @var Cacheer |
|
| 24 | + */ |
|
| 25 | 25 | protected $cacheer; |
| 26 | 26 | |
| 27 | 27 | /** @param string $logPath */ |
@@ -38,10 +38,10 @@ discard block |
||
| 38 | 38 | } |
| 39 | 39 | |
| 40 | 40 | /** |
| 41 | - * Uses the database driver for caching. |
|
| 42 | - * |
|
| 43 | - * @return Cacheer |
|
| 44 | - */ |
|
| 41 | + * Uses the database driver for caching. |
|
| 42 | + * |
|
| 43 | + * @return Cacheer |
|
| 44 | + */ |
|
| 45 | 45 | public function useDatabaseDriver() |
| 46 | 46 | { |
| 47 | 47 | $this->cacheer->cacheStore = new DatabaseCacheStore($this->logPath); |
@@ -49,10 +49,10 @@ discard block |
||
| 49 | 49 | } |
| 50 | 50 | |
| 51 | 51 | /** |
| 52 | - * Uses the file driver for caching. |
|
| 53 | - * |
|
| 54 | - * @return Cacheer |
|
| 55 | - */ |
|
| 52 | + * Uses the file driver for caching. |
|
| 53 | + * |
|
| 54 | + * @return Cacheer |
|
| 55 | + */ |
|
| 56 | 56 | public function useFileDriver() |
| 57 | 57 | { |
| 58 | 58 | $this->cacheer->options['loggerPath'] = $this->logPath; |
@@ -61,10 +61,10 @@ discard block |
||
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | /** |
| 64 | - * Uses the Redis driver for caching. |
|
| 65 | - * |
|
| 66 | - * @return Cacheer |
|
| 67 | - */ |
|
| 64 | + * Uses the Redis driver for caching. |
|
| 65 | + * |
|
| 66 | + * @return Cacheer |
|
| 67 | + */ |
|
| 68 | 68 | public function useRedisDriver() |
| 69 | 69 | { |
| 70 | 70 | $this->cacheer->cacheStore = new RedisCacheStore($this->logPath); |
@@ -72,10 +72,10 @@ discard block |
||
| 72 | 72 | } |
| 73 | 73 | |
| 74 | 74 | /** |
| 75 | - * Uses the array driver for caching. |
|
| 76 | - * |
|
| 77 | - * @return Cacheer |
|
| 78 | - */ |
|
| 75 | + * Uses the array driver for caching. |
|
| 76 | + * |
|
| 77 | + * @return Cacheer |
|
| 78 | + */ |
|
| 79 | 79 | public function useArrayDriver() |
| 80 | 80 | { |
| 81 | 81 | $this->cacheer->cacheStore = new ArrayCacheStore($this->logPath); |
@@ -83,10 +83,10 @@ discard block |
||
| 83 | 83 | } |
| 84 | 84 | |
| 85 | 85 | /** |
| 86 | - * Uses the default driver for caching. |
|
| 87 | - * |
|
| 88 | - * @return Cacheer |
|
| 89 | - */ |
|
| 86 | + * Uses the default driver for caching. |
|
| 87 | + * |
|
| 88 | + * @return Cacheer |
|
| 89 | + */ |
|
| 90 | 90 | public function useDefaultDriver() |
| 91 | 91 | { |
| 92 | 92 | if (!isset($this->cacheer->options['cacheDir'])) { |
@@ -103,16 +103,16 @@ discard block |
||
| 103 | 103 | } |
| 104 | 104 | |
| 105 | 105 | /** |
| 106 | - * Checks if the directory exists or creates it. |
|
| 107 | - * |
|
| 108 | - * @param mixed $dirName |
|
| 109 | - * @return bool |
|
| 110 | - */ |
|
| 106 | + * Checks if the directory exists or creates it. |
|
| 107 | + * |
|
| 108 | + * @param mixed $dirName |
|
| 109 | + * @return bool |
|
| 110 | + */ |
|
| 111 | 111 | private function isDir(mixed $dirName) |
| 112 | 112 | { |
| 113 | - if (is_dir($dirName)) { |
|
| 114 | - return true; |
|
| 115 | - } |
|
| 116 | - return mkdir($dirName, 0755, true); |
|
| 113 | + if (is_dir($dirName)) { |
|
| 114 | + return true; |
|
| 115 | + } |
|
| 116 | + return mkdir($dirName, 0755, true); |
|
| 117 | 117 | } |
| 118 | 118 | } |
@@ -13,20 +13,20 @@ discard block |
||
| 13 | 13 | private mixed $data; |
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | - * CacheDataFormatter constructor. |
|
| 17 | - * |
|
| 18 | - * @param mixed $data |
|
| 19 | - */ |
|
| 16 | + * CacheDataFormatter constructor. |
|
| 17 | + * |
|
| 18 | + * @param mixed $data |
|
| 19 | + */ |
|
| 20 | 20 | public function __construct(mixed $data) |
| 21 | 21 | { |
| 22 | 22 | $this->data = $data; |
| 23 | 23 | } |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * Converts the data to JSON format. |
|
| 27 | - * |
|
| 28 | - * @return string|false |
|
| 29 | - */ |
|
| 26 | + * Converts the data to JSON format. |
|
| 27 | + * |
|
| 28 | + * @return string|false |
|
| 29 | + */ |
|
| 30 | 30 | public function toJson() |
| 31 | 31 | { |
| 32 | 32 | return json_encode( |
@@ -38,30 +38,30 @@ discard block |
||
| 38 | 38 | } |
| 39 | 39 | |
| 40 | 40 | /** |
| 41 | - * Converts the data to an array. |
|
| 42 | - * |
|
| 43 | - * @return array |
|
| 44 | - */ |
|
| 41 | + * Converts the data to an array. |
|
| 42 | + * |
|
| 43 | + * @return array |
|
| 44 | + */ |
|
| 45 | 45 | public function toArray() |
| 46 | 46 | { |
| 47 | 47 | return (array)$this->data; |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | - * Converts the data to a string. |
|
| 52 | - * |
|
| 53 | - * @return string |
|
| 54 | - */ |
|
| 51 | + * Converts the data to a string. |
|
| 52 | + * |
|
| 53 | + * @return string |
|
| 54 | + */ |
|
| 55 | 55 | public function toString() |
| 56 | 56 | { |
| 57 | 57 | return (string)$this->data; |
| 58 | 58 | } |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * Converts the data to an object. |
|
| 62 | - * |
|
| 63 | - * @return object |
|
| 64 | - */ |
|
| 61 | + * Converts the data to an object. |
|
| 62 | + * |
|
| 63 | + * @return object |
|
| 64 | + */ |
|
| 65 | 65 | public function toObject() |
| 66 | 66 | { |
| 67 | 67 | return (object)$this->data; |
@@ -60,12 +60,12 @@ discard block |
||
| 60 | 60 | } |
| 61 | 61 | |
| 62 | 62 | /** |
| 63 | - * Retrieves cache data from the database. |
|
| 64 | - * |
|
| 65 | - * @param string $cacheKey |
|
| 66 | - * @param string $namespace |
|
| 67 | - * @return mixed |
|
| 68 | - */ |
|
| 63 | + * Retrieves cache data from the database. |
|
| 64 | + * |
|
| 65 | + * @param string $cacheKey |
|
| 66 | + * @param string $namespace |
|
| 67 | + * @return mixed |
|
| 68 | + */ |
|
| 69 | 69 | public function retrieve(string $cacheKey, string $namespace = '') |
| 70 | 70 | { |
| 71 | 71 | $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME); |
@@ -85,11 +85,11 @@ discard block |
||
| 85 | 85 | } |
| 86 | 86 | |
| 87 | 87 | /** |
| 88 | - * Retrieves multiple cache items by their keys. |
|
| 89 | - * @param array $cacheKeys |
|
| 90 | - * @param string $namespace |
|
| 91 | - * @return array |
|
| 92 | - */ |
|
| 88 | + * Retrieves multiple cache items by their keys. |
|
| 89 | + * @param array $cacheKeys |
|
| 90 | + * @param string $namespace |
|
| 91 | + * @return array |
|
| 92 | + */ |
|
| 93 | 93 | public function getAll(string $namespace = '') |
| 94 | 94 | { |
| 95 | 95 | $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME); |
@@ -110,10 +110,10 @@ discard block |
||
| 110 | 110 | } |
| 111 | 111 | |
| 112 | 112 | /** |
| 113 | - * Get Update query based on the database driver. |
|
| 114 | - * |
|
| 115 | - * @return string |
|
| 116 | - */ |
|
| 113 | + * Get Update query based on the database driver. |
|
| 114 | + * |
|
| 115 | + * @return string |
|
| 116 | + */ |
|
| 117 | 117 | private function getUpdateQueryWithDriver() |
| 118 | 118 | { |
| 119 | 119 | $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME); |
@@ -124,10 +124,10 @@ discard block |
||
| 124 | 124 | } |
| 125 | 125 | |
| 126 | 126 | /** |
| 127 | - * Get Delete query based on the database driver. |
|
| 128 | - * |
|
| 129 | - * @return string |
|
| 130 | - */ |
|
| 127 | + * Get Delete query based on the database driver. |
|
| 128 | + * |
|
| 129 | + * @return string |
|
| 130 | + */ |
|
| 131 | 131 | private function getDeleteQueryWithDriver() |
| 132 | 132 | { |
| 133 | 133 | $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME); |
@@ -138,13 +138,13 @@ discard block |
||
| 138 | 138 | } |
| 139 | 139 | |
| 140 | 140 | /** |
| 141 | - * Updates an existing cache item in the database. |
|
| 142 | - * |
|
| 143 | - * @param string $cacheKey |
|
| 144 | - * @param mixed $cacheData |
|
| 145 | - * @param string $namespace |
|
| 146 | - * @return bool |
|
| 147 | - */ |
|
| 141 | + * Updates an existing cache item in the database. |
|
| 142 | + * |
|
| 143 | + * @param string $cacheKey |
|
| 144 | + * @param mixed $cacheData |
|
| 145 | + * @param string $namespace |
|
| 146 | + * @return bool |
|
| 147 | + */ |
|
| 148 | 148 | public function update(string $cacheKey, mixed $cacheData, string $namespace = '') |
| 149 | 149 | { |
| 150 | 150 | $query = $this->getUpdateQueryWithDriver(); |
@@ -158,12 +158,12 @@ discard block |
||
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | /** |
| 161 | - * Clears a specific cache item from the database. |
|
| 162 | - * |
|
| 163 | - * @param string $cacheKey |
|
| 164 | - * @param string $namespace |
|
| 165 | - * @return bool |
|
| 166 | - */ |
|
| 161 | + * Clears a specific cache item from the database. |
|
| 162 | + * |
|
| 163 | + * @param string $cacheKey |
|
| 164 | + * @param string $namespace |
|
| 165 | + * @return bool |
|
| 166 | + */ |
|
| 167 | 167 | public function clear(string $cacheKey, string $namespace = '') |
| 168 | 168 | { |
| 169 | 169 | $query = $this->getDeleteQueryWithDriver(); |
@@ -176,10 +176,10 @@ discard block |
||
| 176 | 176 | } |
| 177 | 177 | |
| 178 | 178 | /** |
| 179 | - * Gets the query to renew the expiration time of a cache item based on the database driver. |
|
| 180 | - * |
|
| 181 | - * @return string |
|
| 182 | - */ |
|
| 179 | + * Gets the query to renew the expiration time of a cache item based on the database driver. |
|
| 180 | + * |
|
| 181 | + * @return string |
|
| 182 | + */ |
|
| 183 | 183 | private function getRenewExpirationQueryWithDriver(): string |
| 184 | 184 | { |
| 185 | 185 | $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME); |
@@ -194,13 +194,13 @@ discard block |
||
| 194 | 194 | } |
| 195 | 195 | |
| 196 | 196 | /** |
| 197 | - * Checks if a cache item is valid based on its key, namespace, and current time. |
|
| 198 | - * |
|
| 199 | - * @param string $cacheKey |
|
| 200 | - * @param string $namespace |
|
| 201 | - * @param string $currentTime |
|
| 202 | - * @return bool |
|
| 203 | - */ |
|
| 197 | + * Checks if a cache item is valid based on its key, namespace, and current time. |
|
| 198 | + * |
|
| 199 | + * @param string $cacheKey |
|
| 200 | + * @param string $namespace |
|
| 201 | + * @param string $currentTime |
|
| 202 | + * @return bool |
|
| 203 | + */ |
|
| 204 | 204 | private function hasValidCache(string $cacheKey, string $namespace, string $currentTime): bool |
| 205 | 205 | { |
| 206 | 206 | $stmt = $this->connection->prepare( |
@@ -216,13 +216,13 @@ discard block |
||
| 216 | 216 | } |
| 217 | 217 | |
| 218 | 218 | /** |
| 219 | - * Renews the expiration time of a cache item. |
|
| 220 | - * |
|
| 221 | - * @param string $cacheKey |
|
| 222 | - * @param string|int $ttl |
|
| 223 | - * @param string $namespace |
|
| 224 | - * @return bool |
|
| 225 | - */ |
|
| 219 | + * Renews the expiration time of a cache item. |
|
| 220 | + * |
|
| 221 | + * @param string $cacheKey |
|
| 222 | + * @param string|int $ttl |
|
| 223 | + * @param string $namespace |
|
| 224 | + * @return bool |
|
| 225 | + */ |
|
| 226 | 226 | public function renew(string $cacheKey, string|int $ttl, string $namespace = '') |
| 227 | 227 | { |
| 228 | 228 | $currentTime = date('Y-m-d H:i:s'); |
@@ -242,32 +242,32 @@ discard block |
||
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Flushes all cache items from the database. |
|
| 246 | - * |
|
| 247 | - * @return bool |
|
| 248 | - */ |
|
| 245 | + * Flushes all cache items from the database. |
|
| 246 | + * |
|
| 247 | + * @return bool |
|
| 248 | + */ |
|
| 249 | 249 | public function flush() |
| 250 | 250 | { |
| 251 | 251 | return $this->connection->exec("DELETE FROM cacheer_table") !== false; |
| 252 | 252 | } |
| 253 | 253 | |
| 254 | 254 | /** |
| 255 | - * Serializes or unserializes data based on the provided flag. |
|
| 256 | - * |
|
| 257 | - * @param mixed $data |
|
| 258 | - * @return string |
|
| 259 | - */ |
|
| 255 | + * Serializes or unserializes data based on the provided flag. |
|
| 256 | + * |
|
| 257 | + * @param mixed $data |
|
| 258 | + * @return string |
|
| 259 | + */ |
|
| 260 | 260 | private function serialize(mixed $data, bool $serialize = true) |
| 261 | 261 | { |
| 262 | 262 | return $serialize ? serialize($data) : unserialize($data); |
| 263 | 263 | } |
| 264 | 264 | |
| 265 | 265 | /** |
| 266 | - * Gets the current date and time based on the database driver. |
|
| 267 | - * |
|
| 268 | - * @param string $driver |
|
| 269 | - * @return string |
|
| 270 | - */ |
|
| 266 | + * Gets the current date and time based on the database driver. |
|
| 267 | + * |
|
| 268 | + * @param string $driver |
|
| 269 | + * @return string |
|
| 270 | + */ |
|
| 271 | 271 | private function getCurrentDateTime(string $driver) |
| 272 | 272 | { |
| 273 | 273 | return ($driver === 'sqlite') ? "DATETIME('now', 'localtime')" : "NOW()"; |
@@ -13,112 +13,112 @@ |
||
| 13 | 13 | class TimeBuilder |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** @param string $unit */ |
|
| 17 | - private string $unit; |
|
| 18 | - |
|
| 19 | - /** @param int $value */ |
|
| 20 | - private int $value; |
|
| 21 | - |
|
| 22 | - /** @param Closure $callback */ |
|
| 23 | - private Closure $callback; |
|
| 24 | - |
|
| 25 | - /** @param FileOptionBuilder */ |
|
| 26 | - private $builder = null; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * TimeBuilder constructor. |
|
| 30 | - * @param Closure $callback |
|
| 31 | - * @param FileOptionBuilder $builder |
|
| 32 | - * |
|
| 33 | - * @return void |
|
| 34 | - */ |
|
| 35 | - public function __construct(Closure $callback, $builder) |
|
| 36 | - { |
|
| 16 | + /** @param string $unit */ |
|
| 17 | + private string $unit; |
|
| 18 | + |
|
| 19 | + /** @param int $value */ |
|
| 20 | + private int $value; |
|
| 21 | + |
|
| 22 | + /** @param Closure $callback */ |
|
| 23 | + private Closure $callback; |
|
| 24 | + |
|
| 25 | + /** @param FileOptionBuilder */ |
|
| 26 | + private $builder = null; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * TimeBuilder constructor. |
|
| 30 | + * @param Closure $callback |
|
| 31 | + * @param FileOptionBuilder $builder |
|
| 32 | + * |
|
| 33 | + * @return void |
|
| 34 | + */ |
|
| 35 | + public function __construct(Closure $callback, $builder) |
|
| 36 | + { |
|
| 37 | 37 | $this->callback = $callback; |
| 38 | 38 | $this->builder = $builder; |
| 39 | - } |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * Sets the time in seconds. |
|
| 43 | - * |
|
| 44 | - * @param int $seconds |
|
| 45 | - * @return FileOptionBuilder|mixed |
|
| 46 | - */ |
|
| 47 | - public function second(int $seconds) |
|
| 48 | - { |
|
| 39 | + } |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * Sets the time in seconds. |
|
| 43 | + * |
|
| 44 | + * @param int $seconds |
|
| 45 | + * @return FileOptionBuilder|mixed |
|
| 46 | + */ |
|
| 47 | + public function second(int $seconds) |
|
| 48 | + { |
|
| 49 | 49 | return $this->setTime($seconds, "seconds"); |
| 50 | - } |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Sets the time in minutes. |
|
| 54 | - * |
|
| 55 | - * @param int $minutes |
|
| 56 | - * @return FileOptionBuilder|mixed |
|
| 57 | - */ |
|
| 58 | - public function minute(int $minutes) |
|
| 59 | - { |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Sets the time in minutes. |
|
| 54 | + * |
|
| 55 | + * @param int $minutes |
|
| 56 | + * @return FileOptionBuilder|mixed |
|
| 57 | + */ |
|
| 58 | + public function minute(int $minutes) |
|
| 59 | + { |
|
| 60 | 60 | return $this->setTime($minutes, "minutes"); |
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Sets the time in hours. |
|
| 65 | - * |
|
| 66 | - * @param int $hours |
|
| 67 | - * @return FileOptionBuilder|mixed |
|
| 68 | - */ |
|
| 69 | - public function hour(int $hours) |
|
| 70 | - { |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Sets the time in hours. |
|
| 65 | + * |
|
| 66 | + * @param int $hours |
|
| 67 | + * @return FileOptionBuilder|mixed |
|
| 68 | + */ |
|
| 69 | + public function hour(int $hours) |
|
| 70 | + { |
|
| 71 | 71 | return $this->setTime($hours, "hours"); |
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Sets the time in days. |
|
| 76 | - * |
|
| 77 | - * @param int $days |
|
| 78 | - * @return FileOptionBuilder|mixed |
|
| 79 | - */ |
|
| 80 | - public function day(int $days) |
|
| 81 | - { |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Sets the time in days. |
|
| 76 | + * |
|
| 77 | + * @param int $days |
|
| 78 | + * @return FileOptionBuilder|mixed |
|
| 79 | + */ |
|
| 80 | + public function day(int $days) |
|
| 81 | + { |
|
| 82 | 82 | return $this->setTime($days, "days"); |
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Sets the time in weeks. |
|
| 87 | - * |
|
| 88 | - * @param int $weeks |
|
| 89 | - * @return FileOptionBuilder|mixed |
|
| 90 | - */ |
|
| 91 | - public function week(int $weeks) |
|
| 92 | - { |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Sets the time in weeks. |
|
| 87 | + * |
|
| 88 | + * @param int $weeks |
|
| 89 | + * @return FileOptionBuilder|mixed |
|
| 90 | + */ |
|
| 91 | + public function week(int $weeks) |
|
| 92 | + { |
|
| 93 | 93 | return $this->setTime($weeks, "weeks"); |
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Sets the time in months. |
|
| 98 | - * |
|
| 99 | - * @param int $months |
|
| 100 | - * @return FileOptionBuilder|mixed |
|
| 101 | - */ |
|
| 102 | - public function month(int $months) |
|
| 103 | - { |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Sets the time in months. |
|
| 98 | + * |
|
| 99 | + * @param int $months |
|
| 100 | + * @return FileOptionBuilder|mixed |
|
| 101 | + */ |
|
| 102 | + public function month(int $months) |
|
| 103 | + { |
|
| 104 | 104 | return $this->setTime($months, "months"); |
| 105 | - } |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * This method sets the time value and unit, and invokes the callback with the formatted string. |
|
| 110 | - * |
|
| 111 | - * @param int $value |
|
| 112 | - * @param string $unit |
|
| 113 | - * @return FileOptionBuilder |
|
| 114 | - */ |
|
| 115 | - private function setTime(int $value, string $unit) |
|
| 116 | - { |
|
| 108 | + /** |
|
| 109 | + * This method sets the time value and unit, and invokes the callback with the formatted string. |
|
| 110 | + * |
|
| 111 | + * @param int $value |
|
| 112 | + * @param string $unit |
|
| 113 | + * @return FileOptionBuilder |
|
| 114 | + */ |
|
| 115 | + private function setTime(int $value, string $unit) |
|
| 116 | + { |
|
| 117 | 117 | |
| 118 | 118 | $this->value = $value; |
| 119 | 119 | $this->unit = $unit; |
| 120 | - ($this->callback)("{$value} {$unit}"); |
|
| 120 | + ($this->callback)("{$value} {$unit}"); |
|
| 121 | 121 | return $this->builder; |
| 122 | - } |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | 124 | } |