Contact us

For coders TYPO3 Tech Corner

eID Scripts in TYPO3 10

eID Scripts in TYPO3 10

Since TYPO3 version 10 there are different ways of handling AJAX requests on the server side. On the one hand, TypeNums can simply be registered in TypoScript, and on the other hand, you can also use PSR-15 middleware. In some cases, however, you would also like to use eID. We'll show you how easy it still works.

In our example we have written our own CKEditor plugin that allows editors to insert SVG graphics into the RTE. Since the editors should be able to update and expand these graphics themselves, they are read from one (or more) folders in the fileadmin. We solved the server-side part of this AJAX request via eID.

Registering an eID script is still very easy in the ext_localconf.php in your site package:

<?php
defined('TYPO3_MODE') || die();

call_user_func(
    function () {

        /**
         * eID to get icons from path in CKeditor in2iconinsert plugin (Example call: ?eID=geticonsfrompath)
         */
        $GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']['geticonsfrompath'] =
            \In2code\In2template\Eid\GetIconsFromPath::class;
    }
);

The appropriate eID script can then look something like this, for example, and should return the required information in JSON format:

<?php
declare(strict_types=1);
namespace In2code\In2template\Eid;

use In2code\In2template\Utility\ArrayUtility;
use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Core\Http\JsonResponse;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Class GetIconsFromPath
 */
class GetIconsFromPath
{
    /**
     * @var array
     */
    protected $pathPerType = [
        'icon' => 'fileadmin/IconsRte/Icons/',
        'disturber' => 'fileadmin/IconsRte/Disturber/',
        'signet' => 'fileadmin/IconsRte/Signets/'
    ];

    /**
     * @var array
     */
    protected $allowedFileTypes = [
        'svg'
    ];

    /**
     * @return ResponseInterface
     */
    public function __invoke(): ResponseInterface
    {
        $files = GeneralUtility::getFilesInDir(
            $this->getPath(),
            $this->getAllowedFileTypes(),
            true
        );
        $files = ArrayUtility::prependArrayValue('/', $files);
        return GeneralUtility::makeInstance(JsonResponse::class, array_values($files));
    }

    /**
     * @return string
     */
    protected function getPath()
    {
        $type = GeneralUtility::_GP('type');
        if ($type !== '' && array_key_exists($type, $this->pathPerType)) {
            return $this->pathPerType[$type];
        }
        throw new \LogicException('No valid type given', 1562673364);
    }

    /**
     * @return string
     */
    protected function getAllowedFileTypes()
    {
        return implode(',', $this->allowedFileTypes);
    }
}

Note: The CKEditor plugin or the ArrayUtility :: prependArrayValue () function are not part of this example in order not to unnecessarily bloat the code.

Back

"Code faster, look at the time" - does this sound familiar to you?

How about time and respect for code quality? Working in a team? Automated tests?

Join us