Cacheable::fetch() - Code Metrics - Inspection of "ADD sourcecode" - sfneal/caching - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1023c6...5cd462 )

by Stephen

created 2020-08-18 15:27 UTC

Cacheable::fetch() A

↳ Parent: Cacheable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

<?php


namespace Sfneal\Caching\Traits;


use Illuminate\Database\Eloquent\Collection;
use Illuminate\Support\Facades\Cache;

trait Cacheable
{
    /**
     * @var int Time to live
     */
    public $ttl = null;

    /**
     * Execute the Query
     *
     * @return Collection|int|mixed
     */
    abstract public function execute();

    /**
     * Retrieve the Query cache key
     *
     * @return string
     */
    abstract public function cacheKey(): string;

    /**
     * Fetch cached Query results
     *
     *  - use cacheKey() method to retrieve correct key to use for storing in cache
     *  - use base class's execute() method for retrieving query results
     *
     * @param int|null $ttl
     * @return Collection|mixed
     */
    public function fetch(int $ttl = null) {
        return Cache::remember($this->cacheKey(), $this->getTTL($ttl), function () {
            return $this->execute();
        });
    }

    /**
     * Retrieve the time to live for the cached values
     *  - 1. passed $ttl parameter
     *  - 2. initialized $this->ttl property
     *  - 3. application default cache ttl
     *
     * @param int|null $ttl
     * @return int|mixed
     */
    private function getTTL(int $ttl = null) {
        return $ttl ?? $this->ttl ?? env('REDIS_KEY_EXPIRATION');
    }

    /**
     * Invalidate the Query Cache for this Query
     */
    public function invalidateCache() {
        // todo: refactor to protected method
        // Remove # ID's from cache key
        redisDelete(collect(explode('#', $this->cacheKey(), 1))->first());
        return $this;
    }
}


1			<?php
2
3
4			namespace Sfneal\Caching\Traits;
5
6
7			use Illuminate\Database\Eloquent\Collection;
8			use Illuminate\Support\Facades\Cache;
9
10			trait Cacheable
11			{
12			/**
13			* @var int Time to live
14			*/
15			public $ttl = null;
16
17			/**
18			* Execute the Query
19			*
20			* @return Collection\|int\|mixed
21			*/
22			abstract public function execute();
23
24			/**
25			* Retrieve the Query cache key
26			*
27			* @return string
28			*/
29			abstract public function cacheKey(): string;
30
31			/**
32			* Fetch cached Query results
33			*
34			* - use cacheKey() method to retrieve correct key to use for storing in cache
35			* - use base class's execute() method for retrieving query results
36			*
37			* @param int\|null $ttl
38			* @return Collection\|mixed
39			*/
40			public function fetch(int $ttl = null) {
41			return Cache::remember($this->cacheKey(), $this->getTTL($ttl), function () {
42			return $this->execute();
43			});
44			}
45
46			/**
47			* Retrieve the time to live for the cached values
48			* - 1. passed $ttl parameter
49			* - 2. initialized $this->ttl property
50			* - 3. application default cache ttl
51			*
52			* @param int\|null $ttl
53			* @return int\|mixed
54			*/
55			private function getTTL(int $ttl = null) {
56			return $ttl ?? $this->ttl ?? env('REDIS_KEY_EXPIRATION');
57			}
58
59			/**
60			* Invalidate the Query Cache for this Query
61			*/
62			public function invalidateCache() {
63			// todo: refactor to protected method
64			// Remove # ID's from cache key
65			redisDelete(collect(explode('#', $this->cacheKey(), 1))->first());
66			return $this;
67			}
68			}
69

sfneal / caching

Push — master ( 1023c6...5cd462 )

Cacheable::fetch() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like