yii\annotations\Annotations

Complexity

Total Complexity

15

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	configurationCache()	0	4	1
A	init()	0	5	1
A	trySetCacheFileSuffix()	0	4	2
A	getReader()	0	7	1
A	getDefaultCache()	0	3	1
A	trySetCachePath()	0	4	3
A	registerLoader()	0	5	2
A	enableNewReader()	0	5	2
A	enableCacheComponent()	0	6	2

<?php
namespace yii\annotations;

use Doctrine\Common\Annotations\AnnotationException;
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\AnnotationRegistry;
use Yii;
use yii\base\Component;
use yii\base\InvalidConfigException;
use yii\caching\CacheInterface;
use yii\caching\FileCache;
use yii\di\Instance;

/**
 * Class Annotations
 * @property CacheInterface|object $cacheComponent
 * @property FileCache $defaultCache
 */
class Annotations extends Component implements AnnotationsInterface
{
    /**
     * @var string|CacheInterface
     */
    public $cache = 'cache';

    /**
     * @var bool
     */
    public $debug = false;

    /**
     * @var string
     */
    public $path;

    /**
     * @var AnnotationReader
     */
    private $reader;

    /**
     * @var array
     */
    public $ignoreAnnotations = [];

    /**
     * @var CacheInterface
     */
    private $cacheComponent;

    /**
     * @var FileCache
     */
    private const DEFAULT_CACHE = FileCache::class;

    /**
     * @var string
     */
    protected const CACHE_PREFIX = '.annotations';

    /**
     * @throws InvalidConfigException
     */
    public function init(): void
    {
        parent::init();
        $this->registerLoader();
        $this->enableCacheComponent();
    }

    /**
     * @return AnnotationCacheReader
     * @throws AnnotationException
     */
    public function getReader(): AnnotationCacheReader
    {
        $this->enableNewReader();
        return new AnnotationCacheReader(
            $this->reader,
            new AnnotationCache($this->cacheComponent),
            $this->debug
        );
    }

    /**
     * @return void
     * @throws InvalidConfigException
     */
    private function enableCacheComponent(): void
    {
        $this->cacheComponent = (is_string($this->cache)
                ? Instance::ensure($this->cache)
                : $this->cache) ?? $this->getDefaultCache();
        $this->configurationCache();
    }

    /**
     * Return default cache
     */
    private function getDefaultCache()
    {
        return self::DEFAULT_CACHE;
    }

    /**
     * @return void
     */
    private function configurationCache(): void
    {
        $this->trySetCachePath();
        $this->trySetCacheFileSuffix();
    }

    /**
     * @return void
     */
    private function trySetCachePath(): void
    {
        if (property_exists($this->cacheComponent, 'cachePath') && $this->path !== null) {
            $this->cacheComponent->cachePath = Yii::getAlias($this->path);
        }
    }

    /**
     * @return void
     */
    private function trySetCacheFileSuffix(): void
    {
        if (property_exists($this->cacheComponent, 'cacheFileSuffix')) {
            $this->cacheComponent->cacheFileSuffix = static::CACHE_PREFIX;
        }
    }

    /**
     *
     */
    private function registerLoader()
    {
        if (method_exists(AnnotationRegistry::class, 'registerLoader')) {
            /** @noinspection PhpDeprecationInspection */
            AnnotationRegistry::registerLoader('class_exists');

The function Doctrine\Common\Annotations\AnnotationRegistry::registerLoader() has been deprecated: this method is deprecated and will be removed in doctrine/annotations 2.0 autoloading should be deferred to the globally registered autoloader by then. For now, use @example AnnotationRegistry::registerLoader('class_exists')

        }
    }

    /**
     * @return void
     * @throws AnnotationException
     */
    private function enableNewReader(): void
    {
        $this->reader = new AnnotationReader();
        foreach ($this->ignoreAnnotations as $annotation) {
            $this->reader::addGlobalIgnoredName($annotation);
        }
    }
}