9.5/_typo_script_reference_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\T3editor\Controller;


/*

 * 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 Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Core\Http\JsonResponse;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪TypoScriptReferenceController

{

    protected ‪$xmlDoc;


    public function ‪loadReference(ServerRequestInterface $request): ResponseInterface

    {

        // Load the TSref XML information:

        $this->‪loadFile(GeneralUtility::getFileAbsFileName('EXT:t3editor/Resources/Private/tsref.xml'));

        return (new ‪JsonResponse())->setPayload($this->‪getTypes());

    }


    protected function ‪loadFile($filepath)

    {

        // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept

        $previousValueOfEntityLoader = libxml_disable_entity_loader();

        $this->xmlDoc = new \DOMDocument('1.0', 'utf-8');

        $this->xmlDoc->loadXML(file_get_contents($filepath));

        libxml_disable_entity_loader($previousValueOfEntityLoader);

        // @TODO: oliver@typo3.org: I guess this is not required here

        $this->xmlDoc->saveXML();

    }


    protected function ‪getTypes(): array

    {

        $types = $this->xmlDoc->getElementsByTagName('type');

        $typeArr = [];

        foreach ($types as $type) {

            $typeId = $type->getAttribute('id');

            $typeName = $type->getAttribute('name');

            if (!$typeName) {

                $typeName = $typeId;

            }

            $properties = $type->getElementsByTagName('property');

            $propArr = [];

            foreach ($properties as $property) {

                $p = [];

                $p['name'] = $property->getAttribute('name');

                $p['type'] = $property->getAttribute('type');

                $propArr[$property->getAttribute('name')] = $p;

            }

            $typeArr[$typeId] = [];

            $typeArr[$typeId]['properties'] = $propArr;

            $typeArr[$typeId]['name'] = $typeName;

            if ($type->hasAttribute('extends')) {

                $typeArr[$typeId]['extends'] = $type->getAttribute('extends');

            }

        }

        return $typeArr;

    }

}