9.5/_admin_panel_view_8php_source.html

<?php


namespace ‪TYPO3\CMS\Adminpanel\View;


/*

 * 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 ‪TYPO3\CMS\Adminpanel\ModuleApi\ConfigurableInterface;

use ‪TYPO3\CMS\Adminpanel\ModuleApi\DataProviderInterface;

use ‪TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface;

use ‪TYPO3\CMS\Adminpanel\Service\EditToolbarService;

use ‪TYPO3\CMS\Adminpanel\Utility\StateUtility;

use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;

use ‪TYPO3\CMS\Core\Cache\CacheManager;

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

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


class ‪AdminPanelView

{

    protected ‪$ext_forcePreview = false;


    protected ‪$modules = [];


    protected ‪$configuration;


    public function ‪setModules(array ‪$modules): void

    {

        $this->modules = ‪$modules;

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪getBackendUser()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    /*****************************************************

     * Admin Panel: Deprecated API

     ****************************************************/


    public function ‪callDeprecatedHookObject(): string

    {

        $moduleContent = '';

        if (‪StateUtility::isOpen()) {

            foreach ($this->modules as $module) {

                $moduleContent .= $this->‪getModule($module);

            }


            foreach (

                ‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_adminpanel.php']['extendAdminPanel']

                ??

                [] as $className

            ) {

                trigger_error(

                    'The hook $GLOBALS[TYPO3_CONF_VARS][SC_OPTIONS][tslib/class.tslib_adminpanel.php][extendAdminPanel] will be removed in TYPO3 v10.0, register an AdminPanelModule instead.',

                    E_USER_DEPRECATED

                );

                $hookObject = GeneralUtility::makeInstance($className);

                if (!$hookObject instanceof ‪AdminPanelViewHookInterface) {

                    throw new \UnexpectedValueException(

                        $className . ' must implement interface ' . AdminPanelViewHookInterface::class,

                        1311942539

                    );

                }

                $content = $hookObject->extendAdminPanel($moduleContent, $this);

                if ($content) {

                    $moduleContent .= '<div class="typo3-adminPanel-section typo3-adminPanel-section-open">';

                    $moduleContent .= '  <div class="typo3-adminPanel-section-body">';

                    $moduleContent .= '    ' . $content;

                    $moduleContent .= '  </div>';

                    $moduleContent .= '</div>';

                }

            }

        }

        return $moduleContent;

    }


    protected function ‪getModule(‪ModuleInterface $module): string

    {

        ‪$output = [];


        if ($module instanceof ‪ConfigurableInterface && $module->isEnabled()) {

            ‪$output[] = '<div class="typo3-adminPanel-section typo3-adminPanel-section-open">';

            ‪$output[] = '  <div class="typo3-adminPanel-section-title">';

            ‪$output[] = '    ' . $this->‪getSectionOpenerLink($module);

            ‪$output[] = '  </div>';

            ‪$output[] = '<div class="typo3-adminPanel-section-body">';

            ‪$output[] = '  ' . $module->getContent();

            ‪$output[] = '</div>';

            ‪$output[] = '</div>';

        }


        if ($module instanceof ‪DataProviderInterface) {

            foreach ($module->getJavaScriptFiles() as $javaScriptFile) {

                ‪$output[] =

                    '<script src="' .

                    ‪PathUtility::getAbsoluteWebPath(GeneralUtility::getFileAbsFileName($javaScriptFile)) .

                    '"></script>';

            }

        }


        return implode('', ‪$output);

    }


    /*****************************************************

     * Admin Panel Layout Helper functions

     ****************************************************/


    protected function ‪getSectionOpenerLink(‪ModuleInterface $module): string

    {

        $identifier = $module->‪getIdentifier();

        $onclick = 'document.TSFE_ADMIN_PANEL_FORM[' .

                   GeneralUtility::quoteJSvalue('TSFE_ADMIN_PANEL[display_' . $identifier . ']') .

                   '].value=' .

                   ($this->‪getBackendUser()->uc['AdminPanel']['display_' . $identifier] ? '0' : '1') .

                   ';document.TSFE_ADMIN_PANEL_FORM.submit();return false;';


        ‪$output = [];

        ‪$output[] = '<span class="typo3-adminPanel-section-title-identifier"></span>';

        ‪$output[] = '<a href="javascript:void(0)" onclick="' . htmlspecialchars($onclick) . '">';

        ‪$output[] = '  ' . htmlspecialchars($module->‪getLabel());

        ‪$output[] = '</a>';

        ‪$output[] = '<input type="hidden" name="TSFE_ADMIN_PANEL[display_' .

                    $identifier .

                    ']" value="' .

                    1 .

                    '" />';


        return implode('', ‪$output);

    }


    public function ‪ext_makeToolBar(): string

    {

        trigger_error(

            'AdminPanelView::ext_makeToolBar() will be removed in TYPO3 v10.0, use fluid and backend uri builder to create a toolbar.',

            E_USER_DEPRECATED

        );

        $editToolbarService = GeneralUtility::makeInstance(EditToolbarService::class);

        return $editToolbarService->createToolbar();

    }


    protected function ‪extGetLL($key, $convertWithHtmlspecialchars = true)

    {

        $labelStr = $this->‪getLanguageService()->getLL($key);

        if ($convertWithHtmlspecialchars) {

            $labelStr = htmlspecialchars($labelStr);

        }

        return $labelStr;

    }


    public function ‪getAdminPanelHeaderData()

    {

        trigger_error(

            'AdminPanelView->getAdminPanelHeaderData() will be removed in TYPO3 v10.0. Implement AdminPanelModules via the new API (see AdminPanelModuleInterface).',

            E_USER_DEPRECATED

        );

        $result = '';

        if (!empty(‪$GLOBALS['TBE_STYLES']['stylesheets']['admPanel'])) {

            $stylesheet = GeneralUtility::locationHeaderUrl(‪$GLOBALS['TBE_STYLES']['stylesheets']['admPanel']);

            $result = '<link rel="stylesheet" type="text/css" href="' .

                      htmlspecialchars($stylesheet, ENT_QUOTES | ENT_HTML5) . '" />';

        }

        return $result;

    }


    public function ‪isAdminModuleEnabled($key)

    {

        trigger_error(

            'AdminPanelView->isAdminModuleEnabled() will be removed in TYPO3 v10.0. Implement AdminPanelModules via the new API (see AdminPanelModuleInterface).',

            E_USER_DEPRECATED

        );

        $result = false;

        // Returns TRUE if the module checked is "preview" and the forcePreview flag is set.

        if ($key === 'preview' && $this->ext_forcePreview) {

            $result = true;

        } elseif (!empty($this->configuration['enable.']['all'])) {

            $result = true;

        } elseif (!empty($this->configuration['enable.'][$key])) {

            $result = true;

        }

        return $result;

    }


    public function ‪saveConfigOptions()

    {

        trigger_error(

            'AdminPanelView->saveConfigOptions() will be removed in TYPO3 v10.0. Implement AdminPanelModules via the new API (see AdminPanelModuleInterface).',

            E_USER_DEPRECATED

        );

        $input = GeneralUtility::_GP('TSFE_ADMIN_PANEL');

        $beUser = $this->‪getBackendUser();

        if (is_array($input)) {

            // Setting

            $beUser->uc['AdminPanel'] = array_merge(

                !is_array($beUser->uc['AdminPanel']) ? [] : $beUser->uc['AdminPanel'],

                $input

            );

            unset($beUser->uc['AdminPanel']['action']);


            foreach ($this->modules as $module) {

                if ($module->isEnabled()) {

                    // We use TYPO3_REQUEST for compatibility reasons. The object and this method are deprecated anyway, this should be fine.

                    $module->onSubmit($input, ‪$GLOBALS['TYPO3_REQUEST']);

                }

            }

            // Saving

            $beUser->writeUC();

            // Flush fluid template cache

            $cacheManager = new ‪CacheManager();

            $cacheManager->setCacheConfigurations(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']);

            $cacheManager->getCache('fluid_template')->flush();

        }

    }


    public function ‪extGetFeAdminValue($sectionName, $val = '')

    {

        trigger_error(

            'AdminPanelView->extGetFeAdminValue() will be removed in TYPO3 v10.0. Implement AdminPanelModules via the new API (see AdminPanelModuleInterface).',

            E_USER_DEPRECATED

        );

        if (!$this->‪isAdminModuleEnabled($sectionName)) {

            return null;

        }


        $beUser = $this->‪getBackendUser();

        // Exceptions where the values can be overridden (forced) from backend:

        // deprecated

        if (

            $sectionName === 'edit' && (

                $val === 'displayIcons' && $this->configuration['module.']['edit.']['forceDisplayIcons'] ||

                $val === 'displayFieldIcons' && $this->configuration['module.']['edit.']['forceDisplayFieldIcons'] ||

                $val === 'editNoPopup' && $this->configuration['module.']['edit.']['forceNoPopup']

            )

        ) {

            return true;

        }


        // Override all settings with user TSconfig

        if ($val && isset($this->configuration['override.'][$sectionName . '.'][$val])) {

            return $this->configuration['override.'][$sectionName . '.'][$val];

        }

        if (!$val && isset($this->configuration['override.'][$sectionName])) {

            return $this->configuration['override.'][$sectionName];

        }


        $returnValue = $val ? $beUser->uc['AdminPanel'][$sectionName . '_' . $val] : 1;


        // Exception for preview

        if ($sectionName === 'preview' && $this->ext_forcePreview) {

            return !$val ? true : $returnValue;

        }


        // See if the menu is expanded!

        return $this->‪isAdminModuleOpen($sectionName) ? $returnValue : null;

    }


    public function ‪forcePreview()

    {

        trigger_error(

            'AdminPanelView->forcePreview() will be removed in TYPO3 v10.0. Use new AdminPanel Preview Module instead.',

            E_USER_DEPRECATED

        );

        $this->ext_forcePreview = true;

    }


    public function ‪isAdminModuleOpen($key)

    {

        trigger_error(

            'AdminPanelView->isAdminModuleOpen() will be removed in TYPO3 v10.0. Use new AdminPanel API instead.',

            E_USER_DEPRECATED

        );

        return $this->‪getBackendUser()->uc['AdminPanel']['display_top'] &&

               $this->‪getBackendUser()->uc['AdminPanel']['display_' . $key];

    }


    public function ‪extGetItem($title, $content = '', $checkbox = '', $outerDivClass = null, $innerDivClass = null)

    {

        trigger_error(

            'AdminPanelView->extGetItem() will be removed in TYPO3 v10.0. Use new AdminPanel API instead.',

            E_USER_DEPRECATED

        );

        $title = $title ? '<label for="' . htmlspecialchars($title) . '">' . $this->‪extGetLL($title) . '</label>' : '';

        $out = '';

        $out .= (string)$outerDivClass ? '<div class="' . htmlspecialchars($outerDivClass) . '">' : '<div>';

        $out .= (string)$innerDivClass ? '<div class="' . htmlspecialchars($innerDivClass) . '">' : '<div>';

        $out .= $checkbox . $title . $content . '</div></div>';

        return $out;

    }


    public function ‪extGetHead($sectionSuffix)

    {

        trigger_error(

            'AdminPanelView->extGetHead() will be removed in TYPO3 v10.0. Use new AdminPanel API instead.',

            E_USER_DEPRECATED

        );

        return $this->‪linkSectionHeader($sectionSuffix, $this->‪extGetLL($sectionSuffix));

    }


    public function ‪linkSectionHeader($sectionSuffix, $sectionTitle, $className = '')

    {

        trigger_error(

            'AdminPanelView->linkSectionHeader() will be removed in TYPO3 v10.0. Use new AdminPanel API instead.',

            E_USER_DEPRECATED

        );

        $onclick = 'document.TSFE_ADMIN_PANEL_FORM[' .

                   GeneralUtility::quoteJSvalue('TSFE_ADMIN_PANEL[display_' . $sectionSuffix . ']') .

                   '].value=' .

                   ($this->‪getBackendUser()->uc['AdminPanel']['display_' . $sectionSuffix] ? '0' : '1') .

                   ';document.TSFE_ADMIN_PANEL_FORM.submit();return false;';


        ‪$output = [];

        ‪$output[] = '<span class="typo3-adminPanel-section-title-identifier"></span>';

        ‪$output[] = '<a href="javascript:void(0)" onclick="' . htmlspecialchars($onclick) . '">';

        ‪$output[] = '  ' . $sectionTitle;

        ‪$output[] = '</a>';

        ‪$output[] = '<input type="hidden" name="TSFE_ADMIN_PANEL[display_' .

                    $sectionSuffix .

                    ']" value="' .

                    (int)$this->‪isAdminModuleOpen($sectionSuffix) .

                    '" />';


        return implode('', ‪$output);

    }

}