Phpfastcache\Config\IOConfigurationOption

Complexity

Total Complexity

10

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setSecurityKey()	0	6	1
A	setSecureFileManipulation()	0	5	1
A	getDefaultChmod()	0	3	1
A	isSecureFileManipulation()	0	3	1
A	setCacheFileExtension()	0	16	3
A	getSecurityKey()	0	3	1
A	getCacheFileExtension()	0	3	1
A	setDefaultChmod()	0	5	1

<?php

/**
 *
 * This file is part of Phpfastcache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
 *
 * @author Georges.L (Geolim4)  <contact@geolim4.com>
 * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 */

declare(strict_types=1);

namespace Phpfastcache\Config;

use Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;

class IOConfigurationOption extends ConfigurationOption
{
    protected bool $secureFileManipulation = false;

    protected string $securityKey = '';

    protected string $cacheFileExtension = 'txt';

    protected int $defaultChmod = 0777;

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

    /**
     * @param string $securityKey
     * @return static
     * @throws PhpfastcacheLogicException
     */
    public function setSecurityKey(string $securityKey): static
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->securityKey = $securityKey;

        return $this;
    }

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

    /**
     * @param bool $secureFileManipulation
     * @return self
     * @throws PhpfastcacheLogicException
     */
    public function setSecureFileManipulation(bool $secureFileManipulation): static
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->secureFileManipulation = $secureFileManipulation;
        return $this;
    }


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

    /**
     * @param string $cacheFileExtension
     * @return static
     * @throws PhpfastcacheInvalidConfigurationException
     * @throws PhpfastcacheLogicException
     */
    public function setCacheFileExtension(string $cacheFileExtension): static
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $safeFileExtensions = \explode('|', IOConfigurationOptionInterface::SAFE_FILE_EXTENSIONS);

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

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

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

    /**
     * @param int $defaultChmod
     * @return self
     * @throws PhpfastcacheLogicException
     */
    public function setDefaultChmod(int $defaultChmod): static
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->defaultChmod = $defaultChmod;
        return $this;
    }
}