9.5/_context_help_ajax_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\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\Backend\Utility\BackendUtility;

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

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

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


class ‪ContextHelpAjaxController

{

    public function ‪getHelpAction(ServerRequestInterface $request): ResponseInterface

    {

        $params = $request->getParsedBody()['params'] ?? $request->getQueryParams()['params'];

        if (($params['action'] ?? '') !== 'getContextHelp') {

            throw new \RuntimeException('Action must be set to "getContextHelp"', 1518787887);

        }

        $result = $this->‪getContextHelp($params['table'], $params['field']);

        return new ‪JsonResponse([

            'title' => $result['title'],

            'content' => $result['description'],

            'link' => $result['moreInfo']

        ]);

    }


    protected function ‪getContextHelp($table, $field)

    {

        $helpTextArray = ‪BackendUtility::helpTextArray($table, $field);

        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);

        $moreIcon = $helpTextArray['moreInfo'] ? $iconFactory->getIcon('actions-view-go-forward', ‪Icon::SIZE_SMALL)->render() : '';

        return [

            'title' => $helpTextArray['title'],

            'description' => '<p class="t3-help-short' . ($moreIcon ? ' tipIsLinked' : '') . '">' . $helpTextArray['description'] . $moreIcon . '</p>',

            'id' => $table . '.' . $field,

            'moreInfo' => $helpTextArray['moreInfo']

        ];

    }

}