ExtractorRegistry.php

Go to the documentation of this file.

<?php
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Resource\Index;
 
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ExtractorRegistry implements ‪SingletonInterface
{
    protected ‪$extractors = [];
 
    protected ‪$instances;
 
    public static function ‪getInstance()
    {
        trigger_error(__CLASS__ . '::getInstance() will be removed in TYPO3 v12.0. Use Dependency Injection or GeneralUtility::makeInstance() if DI is not possible.', E_USER_DEPRECATED);
        return GeneralUtility::makeInstance(self::class);
    }
 
    public function ‪registerExtractionService($className)
    {
        if (!class_exists($className)) {
            throw new \InvalidArgumentException('The class "' . $className . '" you are registering is not available', 1422705270);
        }
        if (!in_array(ExtractorInterface::class, class_implements($className) ?: [])) {
            throw new \InvalidArgumentException('The extractor needs to implement the ExtractorInterface', 1422705271);
        }
        $this->extractors[] = $className;
    }
 
    public function ‪getExtractors()
    {
        if ($this->instances === null) {
            $this->instances = [];
 
            ‪$extractors = array_reverse($this->extractors);
            foreach (‪$extractors as $className) {
                $object = $this->‪createExtractorInstance($className);
                $this->instances[] = $object;
            }
 
            if (count($this->instances) > 1) {
                usort($this->instances, [$this, 'compareExtractorPriority']);
            }
        }
        return ‪$this->instances;
    }
 
    public function ‪getExtractorsWithDriverSupport($driverType)
    {
        $allExtractors = $this->‪getExtractors();
 
        $filteredExtractors = [];
        foreach ($allExtractors as $priority => $extractorObject) {
            if (empty($extractorObject->getDriverRestrictions()) ||
                in_array($driverType, $extractorObject->getDriverRestrictions(), true)) {
                $filteredExtractors[$extractorObject->getPriority()][] = $extractorObject;
            }
        }
        return $filteredExtractors;
    }
 
    protected function ‪compareExtractorPriority(‪ExtractorInterface $extractorA, ‪ExtractorInterface $extractorB)
    {
        return $extractorB->‪getPriority() - $extractorA->‪getPriority();
    }
 
    protected function ‪createExtractorInstance($className)
    {
        return GeneralUtility::makeInstance($className);
    }
}