ReflectionService.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Extbase\Reflection;
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\SingletonInterface;
 
class ‪ReflectionService implements ‪SingletonInterface
{
    const ‪CACHE_IDENTIFIER = 'extbase_reflection';
    const ‪CACHE_ENTRY_IDENTIFIER = 'ClassSchematas';
 
    protected ‪$dataCache;
 
    protected ‪$dataCacheNeedsUpdate = false;
 
    protected ‪$classSchemata = [];
 
    private ‪$cachingEnabled = false;
 
    public function ‪__construct(‪CacheManager $cacheManager = null)
    {
        if ($cacheManager instanceof ‪CacheManager) {
            try {
                $this->dataCache = $cacheManager->getCache(static::CACHE_IDENTIFIER);
                $this->cachingEnabled = true;
            } catch (‪NoSuchCacheException $ignoredException) {
                $this->cachingEnabled = false;
            }
 
            if ($this->cachingEnabled) {
                if ((‪$classSchemata = $this->dataCache->get(static::CACHE_ENTRY_IDENTIFIER)) !== false) {
                    $this->classSchemata = ‪$classSchemata;
                }
            }
        }
    }
 
    public function ‪__destruct()
    {
        if ($this->dataCacheNeedsUpdate && $this->cachingEnabled) {
            $this->dataCache->set(static::CACHE_ENTRY_IDENTIFIER, $this->classSchemata);
        }
    }
 
    public function ‪getClassTagsValues($className): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getTags();
    }
 
    public function ‪getClassTagValues($className, $tag): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getTags()[$tag] ?? [];
    }
 
    public function ‪getClassPropertyNames($className): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return array_keys($classSchema->getProperties());
    }
 
    public function ‪getClassSchema($classNameOrObject): ClassSchema
    {
        $className = is_object($classNameOrObject) ? get_class($classNameOrObject) : $classNameOrObject;
        if (isset($this->classSchemata[$className])) {
            return $this->classSchemata[$className];
        }
 
        return $this->‪buildClassSchema($className);
    }
 
    public function ‪hasMethod($className, $methodName): bool
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return false;
        }
 
        return $classSchema->hasMethod($methodName);
    }
 
    public function ‪getMethodTagsValues($className, $methodName): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getMethod($methodName)['tags'] ?? [];
    }
 
    public function ‪getMethodParameters($className, $methodName): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getMethod($methodName)['params'] ?? [];
    }
 
    public function ‪getPropertyTagsValues($className, $propertyName): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getProperty($propertyName)['tags'] ?? [];
    }
 
    public function ‪getPropertyTagValues($className, $propertyName, $tag): array
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return [];
        }
 
        return $classSchema->getProperty($propertyName)['tags'][$tag] ?? [];
    }
 
    public function ‪isClassTaggedWith($className, $tag): bool
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return false;
        }
 
        foreach (array_keys($classSchema->getTags()) as $tagName) {
            if ($tagName === $tag) {
                return true;
            }
        }
 
        return false;
    }
 
    public function ‪isPropertyTaggedWith($className, $propertyName, $tag): bool
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        try {
            $classSchema = $this->‪getClassSchema($className);
        } catch (\Exception $e) {
            return false;
        }
 
        $property = $classSchema->getProperty($propertyName);
 
        if (empty($property)) {
            return false;
        }
 
        return isset($property['tags'][$tag]);
    }
 
    protected function ‪buildClassSchema($className): ClassSchema
    {
        try {
            $classSchema = new ClassSchema($className);
        } catch (\ReflectionException $e) {
            throw new Exception\UnknownClassException($e->getMessage() . '. Reflection failed.', 1278450972, $e);
        }
        $this->classSchemata[$className] = $classSchema;
        $this->dataCacheNeedsUpdate = true;
        return $classSchema;
    }
 
    public function ‪__sleep(): array
    {
        return [];
    }
 
    public function ‪__wakeup(): void
    {
        $this->dataCache = null;
        $this->dataCacheNeedsUpdate = false;
        $this->classSchemata = [];
        $this->cachingEnabled = false;
    }
}