Phpfastcache\Config\ConfigurationOption

Complexity

Total Complexity

52

Size/Duplication

Total Lines	466
Duplicated Lines	0 %

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	getFallback()	0	3	1
A	setDefaultKeyHashFunction()	0	7	3
A	isIgnoreSymfonyNotice()	0	3	1
A	setFallbackConfig()	0	11	4
A	setCompressData()	0	4	1
A	setLimitedMemoryByObject()	0	4	1
A	getFallbackConfig()	0	3	1
A	setItemDetailedDate()	0	4	1
A	setCacheSlamsTimeout()	0	4	1
A	setDefaultTtl()	0	4	1
A	isValidOption()	0	3	1
A	getDefaultKeyHashFunction()	0	3	1
A	getOption()	0	4	1
A	isPreventCacheSlams()	0	3	1
A	getCacheSlamsTimeout()	0	3	1
A	getDefaultChmod()	0	3	1
B	setCacheFileExtension()	0	24	3
A	getPath()	0	3	1
A	isAutoTmpFallback()	0	3	1
A	isItemDetailedDate()	0	3	1
A	getDefaultTtl()	0	3	1
A	getDefaultFileNameHashFunction()	0	3	1
A	getCacheFileExtension()	0	3	1
A	isCompressData()	0	3	1
A	setPath()	0	4	1
A	setDefaultChmod()	0	4	1
A	setAutoTmpFallback()	0	4	1
A	setPreventCacheSlams()	0	4	1
A	setFallback()	0	4	1
C	__construct()	0	49	10
A	getLimitedMemoryByObject()	0	3	1
A	setDefaultFileNameHashFunction()	0	7	3
A	setIgnoreSymfonyNotice()	0	7	2

<?php
/**
 * Created by PhpStorm.
 * User: Geolim4
 * Date: 10/02/2018
 * Time: 18:45
 */

namespace Phpfastcache\Config;

use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
use Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException;
use Phpfastcache\Util\ArrayObject;

class ConfigurationOption extends ArrayObject
{
    /**
     * @var bool
     */
    protected $itemDetailedDate = false;

    /**
     * @var bool
     */
    protected $autoTmpFallback = false;

    /**
     * @var bool
     * @deprecated Do not use this option anymore
     */
    protected $ignoreSymfonyNotice = false;

    /**
     * @var int
     */
    protected $defaultTtl = 900;

    /**
     * @var string|Callable
     */
    protected $defaultKeyHashFunction = 'md5';

    /**
     * @var string|Callable
     */
    protected $defaultFileNameHashFunction = 'md5';

    /**
     * @var int
     */
    protected $defaultChmod = 0777;

    /**
     * @var string
     */
    protected $path = '';

    /**
     * @var string
     */
    protected $fallback = '';

    /**
     * @var \Phpfastcache\Config\ConfigurationOption
     */
    protected $fallbackConfig;

    /**
     * @var int
     */
    protected $limitedMemoryByObject = 4096;

    /**
     * @var bool
     */
    protected $compressData = false;

    /**
     * @var bool
     */
    protected $preventCacheSlams = false;

    /**
     * @var int
     */
    protected $cacheSlamsTimeout = 15;

    /**
     * @var string
     */
    protected $cacheFileExtension = 'txt';

    /**
     * @param $args
     * ArrayObject constructor.
     */
    public function __construct(...$args)
    {
        parent::__construct(...$args);
        $array =& $this->getArray();

        /**
         * Detect unwanted keys and throw an exception.
         * No more kidding now, it's 21th century.
         */
        if(array_diff_key($array, get_object_vars($this))){
            throw new PhpfastcacheInvalidConfigurationException(\sprintf(
              'Invalid option(s) for the config %s: %s',
              static::class,
              implode(', ',  array_keys(array_diff_key($array, get_object_vars($this))))
            ));
        }

        foreach (get_object_vars($this) as $property => $value) {

            if(array_key_exists($property, $array)){
                $this->$property = &$array[ $property ];
            }else{
                $array[ $property ] = &$this->$property;
            }
        }

        foreach (get_class_methods($this) as $method) {
            if(strpos($method, 'set') === 0){
                $value = null;

The assignment to $value is dead and can be removed.

                try{
                    /**
                     * We use property instead of getter
                     * because of is/get conditions and
                     * to allow us to retrieve the value
                     * in catch statement bloc
                     */
                    $value = $this->{lcfirst(substr($method, 3))};
                    $this->{$method}($value);
                }catch(\TypeError $e){
                    $typeHintGot = \is_object($value) ? \get_class($value) : \gettype($value);
                    $reflectionMethod = new \ReflectionMethod($this, $method);
                    $parameter = $reflectionMethod->getParameters()[0] ?? null;
                    $typeHintExpected = ($parameter instanceof \ReflectionParameter ? ($parameter->getType() === 'object' ? $parameter->getClass() : $parameter->getType()) : 'Unknown type');

                    throw new PhpfastcacheInvalidConfigurationException(\sprintf(
                      'Invalid type hint found for "%s", expected "%s" got "%s"',
                      lcfirst(substr($method, 3)),
                      $typeHintExpected,
                      $typeHintGot
                    ));
                }
            }
        }
    }

    /**
     * @param string $optionName
     * @return mixed|null
     * @deprecated Use ->getOptionName() instead
     */
    public function getOption(string $optionName)
    {
        \trigger_error(\sprintf('Method "%s" is deprecated, use "getOptionName()" instead', __METHOD__), E_USER_DEPRECATED);
        return $this->$optionName ?? null;
    }

    /**
     * @param string $optionName
     * @return mixed|null
     */
    public function isValidOption(string $optionName)
    {
        return property_exists($this, $optionName);
    }

    /**
     * @return bool
     */
    public function isItemDetailedDate(): bool
    {
        return $this->itemDetailedDate;
    }

    /**
     * @param bool $itemDetailedDate
     * @return ConfigurationOption
     */
    public function setItemDetailedDate(bool $itemDetailedDate): self
    {
        $this->itemDetailedDate = $itemDetailedDate;
        return $this;
    }

    /**
     * @return bool
     */
    public function isAutoTmpFallback(): bool
    {
        return $this->autoTmpFallback;
    }

    /**
     * @param bool $autoTmpFallback
     * @return ConfigurationOption
     */
    public function setAutoTmpFallback(bool $autoTmpFallback): self
    {
        $this->autoTmpFallback = $autoTmpFallback;
        return $this;
    }

    /**
     * @return bool
     * @deprecated As of V7
     */
    public function isIgnoreSymfonyNotice(): bool
    {
        return $this->ignoreSymfonyNotice;

The property Phpfastcache\Config\ConfigurationOption::$ignoreSymfonyNotice has been deprecated: Do not use this option anymore

    }

    /**
     * @param bool $ignoreSymfonyNotice
     * @return ConfigurationOption
     * @deprecated As of V7
     */
    public function setIgnoreSymfonyNotice(bool $ignoreSymfonyNotice): self
    {
        if($ignoreSymfonyNotice){
            \trigger_error('Configuration option "ignoreSymfonyNotice" is deprecated as of the V7', E_USER_DEPRECATED);
        }
        $this->ignoreSymfonyNotice = $ignoreSymfonyNotice;

The property Phpfastcache\Config\ConfigurationOption::$ignoreSymfonyNotice has been deprecated: Do not use this option anymore

        return $this;
    }

    /**
     * @return int
     */
    public function getDefaultTtl(): int
    {
        return $this->defaultTtl;
    }

    /**
     * @param int $defaultTtl
     * @return ConfigurationOption
     */
    public function setDefaultTtl(int $defaultTtl): self
    {
        $this->defaultTtl = $defaultTtl;
        return $this;
    }

    /**
     * @return Callable|string
     */
    public function getDefaultKeyHashFunction()
    {
        return $this->defaultKeyHashFunction;
    }

    /**
     * @param Callable|string $defaultKeyHashFunction
     * @return ConfigurationOption
     * @throws  PhpfastcacheInvalidConfigurationException
     */
    public function setDefaultKeyHashFunction($defaultKeyHashFunction)
    {
        if (!\function_exists($defaultKeyHashFunction) || !\is_callable($defaultKeyHashFunction)) {

It seems like $defaultKeyHashFunction can also be of type callable; however, parameter $function_name of function_exists() does only seem to accept string, maybe add an additional type check?

            throw new PhpfastcacheInvalidConfigurationException('defaultKeyHashFunction must be a valid function name string');
        }
        $this->defaultKeyHashFunction = $defaultKeyHashFunction;
        return $this;
    }

    /**
     * @return Callable|string
     */
    public function getDefaultFileNameHashFunction()
    {
        return $this->defaultFileNameHashFunction;
    }

    /**
     * @param Callable|string $defaultKeyHashFunction
     * @return ConfigurationOption
     * @throws  PhpfastcacheInvalidConfigurationException
     */
    public function setDefaultFileNameHashFunction($defaultFileNameHashFunction)
    {
        if (!\function_exists($defaultFileNameHashFunction) || !\is_callable($defaultFileNameHashFunction)) {
            throw new PhpfastcacheInvalidConfigurationException('defaultFileNameHashFunction must be a valid function name string');
        }
        $this->defaultFileNameHashFunction = $defaultFileNameHashFunction;
        return $this;
    }

    /**
     * @return int
     */
    public function getDefaultChmod(): int
    {
        return $this->defaultChmod;
    }

    /**
     * @param int $defaultChmod
     * @return ConfigurationOption
     */
    public function setDefaultChmod(int $defaultChmod): self
    {
        $this->defaultChmod = $defaultChmod;
        return $this;
    }

    /**
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * @param string $path
     * @return ConfigurationOption
     */
    public function setPath(string $path): self
    {
        $this->path = $path;
        return $this;
    }

    /**
     * @return bool|string
     */
    public function getFallback()
    {
        return $this->fallback;
    }

    /**
     * @param string $fallback
     * @return ConfigurationOption
     */
    public function setFallback(string $fallback): self
    {
        $this->fallback = $fallback;
        return $this;
    }

    /**
     * @return \Phpfastcache\Config\ConfigurationOption|null
     */
    public function getFallbackConfig()
    {
        return $this->fallbackConfig;
    }

    /**
     * @param \Phpfastcache\Config\ConfigurationOption|null $fallbackConfig
     * @return ConfigurationOption
     */
    public function setFallbackConfig($fallbackConfig): self
    {
        if($fallbackConfig !== null && !($fallbackConfig instanceof self)){

$fallbackConfig is always a sub-type of self.

            throw new PhpfastcacheInvalidArgumentException(\sprintf(
              'Invalid argument "%s" for %s',
              gettype($fallbackConfig) === 'object' ? get_class($fallbackConfig) : gettype($fallbackConfig),
              __METHOD__
            ));
        }
        $this->fallbackConfig = $fallbackConfig;
        return $this;
    }

    /**
     * @return int
     */
    public function getLimitedMemoryByObject(): int
    {
        return $this->limitedMemoryByObject;
    }

    /**
     * @param int $limitedMemoryByObject
     * @return ConfigurationOption
     */
    public function setLimitedMemoryByObject(int $limitedMemoryByObject): self
    {
        $this->limitedMemoryByObject = $limitedMemoryByObject;
        return $this;
    }

    /**
     * @return bool
     */
    public function isCompressData(): bool
    {
        return $this->compressData;
    }

    /**
     * @param bool $compressData
     * @return ConfigurationOption
     */
    public function setCompressData(bool $compressData): self
    {
        $this->compressData = $compressData;
        return $this;
    }

    /**
     * @return bool
     */
    public function isPreventCacheSlams(): bool
    {
        return $this->preventCacheSlams;
    }

    /**
     * @param bool $preventCacheSlams
     * @return ConfigurationOption
     */
    public function setPreventCacheSlams(bool $preventCacheSlams): self
    {
        $this->preventCacheSlams = $preventCacheSlams;
        return $this;
    }

    /**
     * @return int
     */
    public function getCacheSlamsTimeout(): int
    {
        return $this->cacheSlamsTimeout;
    }

    /**
     * @param int $cacheSlamsTimeout
     * @return ConfigurationOption
     */
    public function setCacheSlamsTimeout(int $cacheSlamsTimeout): self
    {
        $this->cacheSlamsTimeout = $cacheSlamsTimeout;
        return $this;
    }

    /**
     * @return string
     */
    public function getCacheFileExtension(): string
    {
        return $this->cacheFileExtension;
    }

    /**
     * @param string $cacheFileExtension
     * @return ConfigurationOption
     * @throws PhpfastcacheInvalidConfigurationException
     */
    public function setCacheFileExtension(string $cacheFileExtension): self
    {
        /**
         * Feel free to propose your own one
         * by opening a pull request :)
         */
        static $safeFileExtensions = [
          'txt',
          'cache',
          'db',
          'pfc',
        ];

        if (\strpos($cacheFileExtension, '.') !== false) {
            throw new PhpfastcacheInvalidConfigurationException('cacheFileExtension cannot contain a dot "."');
        }
        if (!\in_array($cacheFileExtension, $safeFileExtensions, true)) {
            throw new PhpfastcacheInvalidConfigurationException(
              "Extension \"{$cacheFileExtension}\" is not safe, currently allowed extension names: " . \implode(', ', $safeFileExtensions)
            );
        }

        $this->cacheFileExtension = $cacheFileExtension;
        return $this;
    }
}