Phpfastcache\Config\AbstractConfigurationOption

Complexity

Total Complexity

6

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	lock()	0	6	1
A	enforceLockedProperty()	0	13	3
A	isLocked()	0	3	1
A	lockedBy()	0	3	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\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;

abstract class AbstractConfigurationOption implements LockableConfigurationInterface
{
    private bool $lockedObject = false;

    private ExtendedCacheItemPoolInterface $locker;

    public function lock(ExtendedCacheItemPoolInterface $poolInstance): static
    {
        $this->lockedObject = true;
        $this->locker = $poolInstance;

        return $this;
    }

    public function lockedBy(): ExtendedCacheItemPoolInterface
    {
        return $this->locker;
    }

    public function isLocked(): bool
    {
        return $this->lockedObject;
    }

    /**
     * @throws PhpfastcacheLogicException
     */
    protected function enforceLockedProperty(string $method): void
    {
        if ($this->lockedObject === true) {
            $dbt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 2);
            $cause = $dbt[\array_key_last($dbt)] ?? null;
            if ($cause) {
                $moreInfo = \sprintf('Caused line %d in %s', $cause['line'], $cause['file']);
            }
            throw new PhpfastcacheLogicException(
                \sprintf(
                    'You can no longer change the configuration "%s" as the cache pool instance is now running. %s',
                    \lcfirst(\substr($method, 3)),
                    $moreInfo ?? ''
                )
            );
        }
    }
}