ContextHelpDataProvider.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\ContextHelp\ExtDirect;

class ContextHelpDataProvider {

    public function getContextHelp($table, $field) {
        $helpTextArray = \TYPO3\CMS\Backend\Utility\BackendUtility::helpTextArray($table, $field);
        $moreIcon = $helpTextArray['moreInfo'] ? \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon('actions-view-go-forward') : '';
        return array(
            'title' => $helpTextArray['title'],
            'description' => '<p class="t3-help-short' . ($moreIcon ? ' tipIsLinked' : '') . '">' . $helpTextArray['description'] . $moreIcon . '</p>',
            'id' => $table . '.' . $field,
            'moreInfo' => $helpTextArray['moreInfo']
        );
    }

    public function getTableContextHelp($table) {
        $output = array();
        if (!isset($GLOBALS['TCA_DESCR'][$table]['columns'])) {
            $GLOBALS['LANG']->loadSingleTableDescription($table);
        }
        if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'])) {
            $arrow = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon('actions-view-go-forward');
            foreach ($GLOBALS['TCA_DESCR'][$table]['columns'] as $field => $data) {
                $output[$field] = array(
                    'description' => NULL,
                    'title' => NULL,
                    'moreInfo' => FALSE,
                    'id' => $table . '.' . $field
                );
                // Add alternative title, if defined
                if ($data['alttitle']) {
                    $output[$field]['title'] = $data['alttitle'];
                }
                // If we have more information to show
                if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
                    $output[$field]['moreInfo'] = TRUE;
                }
                // Add description
                if ($data['description']) {
                    $output[$field]['description'] = $data['description'] . ($output[$field]['moreInfo'] ? $arrow : '');
                }
            }
        }
        return $output;
    }

}