AbstractFunctionModule.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Module;

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class AbstractFunctionModule {

    public $pObj;

    public $thisPath = '';

    public $localLangFile = 'locallang.php';

    public $extClassConf;

    public $function_key = '';

    public function init(&$pObj, $conf) {
        $this->pObj = $pObj;
        // Path of this script:
        $reflector = new \ReflectionObject($this);
        $this->thisPath = dirname($reflector->getFilename());
        if (!@is_dir($this->thisPath)) {
            throw new \RuntimeException('TYPO3 Fatal Error: Could not find path for class ' . get_class($this), 1381164687);
        }
        // Local lang:
        $this->incLocalLang();
        // 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]);
            if (is_array($this->extClassConf) && $this->extClassConf['path']) {
                $this->pObj->include_once[] = $this->extClassConf['path'];
            }
        }
    }

    public function incLocalLang() {
        if ($this->localLangFile && (@is_file(($this->thisPath . '/' . $this->localLangFile)) || @is_file(($this->thisPath . '/' . substr($this->localLangFile, 0, -4) . '.xml')) || @is_file(($this->thisPath . '/' . substr($this->localLangFile, 0, -4) . '.xlf')))) {
            $LOCAL_LANG = $GLOBALS['LANG']->includeLLFile($this->thisPath . '/' . $this->localLangFile, FALSE);
            if (is_array($LOCAL_LANG)) {
                $GLOBALS['LOCAL_LANG'] = (array)$GLOBALS['LOCAL_LANG'];
                \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($GLOBALS['LOCAL_LANG'], $LOCAL_LANG);
            }
        }
    }

    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 array();
    }

}