TypoScriptReferenceLoader.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\T3editor;

class TypoScriptReferenceLoader {

    protected $xmlDoc;

    protected $ajaxObj;

    public function __construct() {
        $GLOBALS['LANG']->includeLLFile('EXT:t3editor/locallang.xlf');
    }

    public function processAjaxRequest($params, \TYPO3\CMS\Core\Http\AjaxRequestHandler &$ajaxObj) {
        $this->ajaxObj = $ajaxObj;
        // Load the TSref XML information:
        $this->loadFile(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('t3editor') . 'res/tsref/tsref.xml');
        $ajaxIdParts = explode('::', $ajaxObj->getAjaxID(), 2);
        $ajaxMethod = $ajaxIdParts[1];
        $response = array();
        // Process the AJAX requests:
        if ($ajaxMethod == 'getTypes') {
            $ajaxObj->setContent($this->getTypes());
            $ajaxObj->setContentFormat('jsonbody');
        } elseif ($ajaxMethod == 'getDescription') {
            $ajaxObj->addContent('', $this->getDescription(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('typeId'), \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('parameterName')));
            $ajaxObj->setContentFormat('plain');
        }
    }

    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(TRUE);
        $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() {
        $types = $this->xmlDoc->getElementsByTagName('type');
        $typeArr = array();
        foreach ($types as $type) {
            $typeId = $type->getAttribute('id');
            $typeName = $type->getAttribute('name');
            if (!$typeName) {
                $typeName = $typeId;
            }
            $properties = $type->getElementsByTagName('property');
            $propArr = array();
            foreach ($properties as $property) {
                $p = array();
                $p['name'] = $property->getAttribute('name');
                $p['type'] = $property->getAttribute('type');
                $propArr[$property->getAttribute('name')] = $p;
            }
            $typeArr[$typeId] = array();
            $typeArr[$typeId]['properties'] = $propArr;
            $typeArr[$typeId]['name'] = $typeName;
            if ($type->hasAttribute('extends')) {
                $typeArr[$typeId]['extends'] = $type->getAttribute('extends');
            }
        }
        return $typeArr;
    }

    protected function getDescription($typeId, $parameterName = '') {
        if (!$typeId) {
            $this->ajaxObj->setError($GLOBALS['LANG']->getLL('typeIDMissing'));
            return '';
        }
        // getElementById does only work with schema
        $type = $this->getType($typeId);
        // Retrieve propertyDescription
        if ($parameterName) {
            $properties = $type->getElementsByTagName('property');
            foreach ($properties as $propery) {
                $propName = $propery->getAttribute('name');
                if ($propName == $parameterName) {
                    $descriptions = $propery->getElementsByTagName('description');
                    if ($descriptions->length) {
                        $description = $descriptions->item(0)->textContent;
                        $description = htmlspecialchars($description);
                        $description = nl2br($description);
                        return $description;
                    }
                }
            }
        }
        return '';
    }

    protected function getType($typeId) {
        $types = $this->xmlDoc->getElementsByTagName('type');
        foreach ($types as $type) {
            if ($type->getAttribute('id') == $typeId) {
                return $type;
            }
        }
    }

}