AbstractFunctionModule.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Module;
 
/*
 * 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\Backend\Template\DocumentTemplate;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractFunctionModule
{
    public ‪$pObj;
 
    public ‪$extObj;
 
    public ‪$localLangFile = '';
 
    public ‪$extClassConf;
 
    public ‪$function_key = '';
 
    protected ‪$pageRenderer;
 
    public function ‪__construct()
    {
        trigger_error(
            'Class AbstractFunctionModule is deprecated and will be removed in TYPO3 v10.0',
            E_USER_DEPRECATED
        );
    }
 
    public function ‪init(‪$pObj)
    {
        $this->pObj = ‪$pObj;
        // Local lang:
        if (!empty($this->localLangFile)) {
            $this->‪getLanguageService()->‪includeLLFile($this->localLangFile);
        }
        // Setting MOD_MENU items as we need them for logging:
        $this->pObj->MOD_MENU = array_merge($this->pObj->MOD_MENU, $this->modMenu());
    }
 
    public function ‪handleExternalFunctionValue()
    {
        // Must clean first to make sure the correct key is set...
        $this->pObj->MOD_SETTINGS = ‪BackendUtility::getModuleData($this->pObj->MOD_MENU, GeneralUtility::_GP('SET'), $this->pObj->MCONF['name']);
        if ($this->function_key) {
            $this->extClassConf = $this->pObj->getExternalItemConfig($this->pObj->MCONF['name'], $this->function_key, $this->pObj->MOD_SETTINGS[$this->function_key]);
        }
    }
 
    public function ‪checkExtObj()
    {
        if (is_array($this->extClassConf) && $this->extClassConf['name']) {
            $this->extObj = GeneralUtility::makeInstance($this->extClassConf['name']);
            $this->extObj->init($this->pObj, $this->extClassConf);
            // Re-write:
            $this->pObj->MOD_SETTINGS = ‪BackendUtility::getModuleData($this->pObj->MOD_MENU, GeneralUtility::_GP('SET'), $this->pObj->MCONF['name']);
        }
    }
 
    public function ‪extObjContent()
    {
        if (is_object($this->extObj)) {
            return $this->extObj->main();
        }
    }
 
    public function ‪modMenu()
    {
        return [];
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUserAuthentication()
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getDocumentTemplate()
    {
        return ‪$GLOBALS['TBE_TEMPLATE'];
    }
 
    protected function ‪getPageRenderer()
    {
        if ($this->pageRenderer === null) {
            $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
        }
 
        return ‪$this->pageRenderer;
    }
}