BaseAdapter::load() - Code Metrics - dzubchik/php-circuit-breaker - Measure and Improve Code Quality continuously with Scrutinizer

BaseAdapter::load()
last analyzed 2017-03-09 21:35 UTC

↳ Parent: BaseAdapter

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
ccs	0
cts	0
cp	0
c	0
b	0
f	0
nc	1

<?php
declare(strict_types = 1);


namespace Paymaxi\Component\CircuitBreaker\Storage\Adapter;

use Paymaxi\Component\CircuitBreaker\Storage\StorageInterface;

/**
 * Parent with potentially reusable functions of cache adapters
 *
 * @see \Paymaxi\Component\CircuitBreaker\Storage\StorageInterface
 * @package Paymaxi\Component\CircuitBreaker\Components
 */
abstract class BaseAdapter implements StorageInterface {

    /**
     * @var int value in seconds, how long should the stats array persist in cache
     */
    protected $ttl;

    /**
     * @var string cache key prefix, might be overridden in constructor in the future
     */
    protected $cachePrefix = "PaymaxiComponentCircuitBreaker";

    /**
     * Configure instance
     *
     * @param Integer $ttl          How long should circuit breaker data persist (between updates)
     * @param String  $cachePrefix  Value has to be string. If empty default cache key prefix is used.
     */
    public function __construct(int $ttl = 3600, string $cachePrefix = null) {
        $this->ttl = $ttl;
        if ($cachePrefix && is_string($cachePrefix)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->cachePrefix = $cachePrefix;
        }
    }

    /**
     * Loads circuit breaker service status value.
     * For example failures count or last retry time.
     * Method does not care what are the attribute names. They are not inspected.
     * Any string can be passed as service name and attribute name.
     *
     * @param 	string  $serviceName   name of service to load stats for
     * @param 	string  $attributeName name of attribute to load
     * @return 	string  value stored or '' if value was not found
     *  
     * @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
     */
    public function loadStatus($serviceName, $attributeName) {
        // try to load the data
        $stats = $this->load($this->cachePrefix . $serviceName . $attributeName);
        // if the value loaded is empty return empty string
        if (empty($stats)) {
            $stats = "";
        }
        return $stats;
    }

    /**
     * Saves circuit breaker service status value.
     * Method does not care what are the attribute names. They are not inspected.
     * Any string can be passed as service name and attribute name, value can be int/string.
     *
     * Saving in storage is not guaranteed unless flush is set to true.
     * Use calls without flush if you know you will update more than one value and you want to
     * improve performance of the calls.
     *
     * @param 	string  $serviceName   name of service to load stats for
     * @param 	string  $attributeName name of the attribute to load
     * @param 	string  $value         string value loaded or '' if nothing found
     * @param   boolean $flush         set to true will force immediate save, false does not guaranteed saving at all.
     * @return 	void
     *
     * @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
     */
    public function saveStatus($serviceName, $attributeName, $value, $flush = false) {
        // store stats
        $this->save($this->cachePrefix . $serviceName . $attributeName, $value, $this->ttl);
    }

    /**
     * Loads item by cache key.
     *
     * @param string $key
     * @return mixed
     *
     * @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
     */
    abstract protected function load($key);

    /**
     * Save item in the cache.
     *
     * @param string $key
     * @param string $value
     * @param int $ttl
     * @return void
     *
     * @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
     */
    abstract protected function save($key, $value, $ttl);
}

1		<?php
2		declare(strict_types = 1);
3
4
5		namespace Paymaxi\Component\CircuitBreaker\Storage\Adapter;
6
7		use Paymaxi\Component\CircuitBreaker\Storage\StorageInterface;
8
9		/**
10		* Parent with potentially reusable functions of cache adapters
11		*
12		* @see \Paymaxi\Component\CircuitBreaker\Storage\StorageInterface
13		* @package Paymaxi\Component\CircuitBreaker\Components
14		*/
15		abstract class BaseAdapter implements StorageInterface {
16
17		/**
18		* @var int value in seconds, how long should the stats array persist in cache
19		*/
20		protected $ttl;
21
22		/**
23		* @var string cache key prefix, might be overridden in constructor in the future
24		*/
25		protected $cachePrefix = "PaymaxiComponentCircuitBreaker";
26
27		/**
28		* Configure instance
29		*
30		* @param Integer $ttl How long should circuit breaker data persist (between updates)
31		* @param String $cachePrefix Value has to be string. If empty default cache key prefix is used.
32		*/
33	5	public function __construct(int $ttl = 3600, string $cachePrefix = null) {
34	5	$this->ttl = $ttl;
35	5	if ($cachePrefix && is_string($cachePrefix)) {
		0 ignored issues – show Bug Best Practice introduced 2017-03-09 20:54 UTC by Report Bug Copy Issue Report The expression `$cachePrefix` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
36		$this->cachePrefix = $cachePrefix;
37		}
38	5	}
39
40		/**
41		* Loads circuit breaker service status value.
42		* For example failures count or last retry time.
43		* Method does not care what are the attribute names. They are not inspected.
44		* Any string can be passed as service name and attribute name.
45		*
46		* @param string $serviceName name of service to load stats for
47		* @param string $attributeName name of attribute to load
48		* @return string value stored or '' if value was not found
49		*
50		* @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
51		*/
52	5	public function loadStatus($serviceName, $attributeName) {
53		// try to load the data
54	5	$stats = $this->load($this->cachePrefix . $serviceName . $attributeName);
55		// if the value loaded is empty return empty string
56	5	if (empty($stats)) {
57	4	$stats = "";
58		}
59	5	return $stats;
60		}
61
62		/**
63		* Saves circuit breaker service status value.
64		* Method does not care what are the attribute names. They are not inspected.
65		* Any string can be passed as service name and attribute name, value can be int/string.
66		*
67		* Saving in storage is not guaranteed unless flush is set to true.
68		* Use calls without flush if you know you will update more than one value and you want to
69		* improve performance of the calls.
70		*
71		* @param string $serviceName name of service to load stats for
72		* @param string $attributeName name of the attribute to load
73		* @param string $value string value loaded or '' if nothing found
74		* @param boolean $flush set to true will force immediate save, false does not guaranteed saving at all.
75		* @return void
76		*
77		* @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
78		*/
79	5	public function saveStatus($serviceName, $attributeName, $value, $flush = false) {
80		// store stats
81	5	$this->save($this->cachePrefix . $serviceName . $attributeName, $value, $this->ttl);
82	5	}
83
84		/**
85		* Loads item by cache key.
86		*
87		* @param string $key
88		* @return mixed
89		*
90		* @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
91		*/
92		abstract protected function load($key);
93
94		/**
95		* Save item in the cache.
96		*
97		* @param string $key
98		* @param string $value
99		* @param int $ttl
100		* @return void
101		*
102		* @throws \Paymaxi\Component\CircuitBreaker\Storage\StorageException if storage error occurs, handler can not be used
103		*/
104		abstract protected function save($key, $value, $ttl);
105		}

dzubchik / php-circuit-breaker

BaseAdapter::load() last analyzed 2017-03-09 21:35 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BaseAdapter::load()
last analyzed 2017-03-09 21:35 UTC