Paymaxi\Component\CircuitBreaker\Storage\Adapter\BaseAdapter

Complexity

Total Complexity

6

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

92.31%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	3
A	loadStatus()	0	9	2
A	saveStatus()	0	4	1
	load()	0	1	?
	save()	0	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)) {

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.

            $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);
}