RecyclerModuleController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Recycler\Controller;

use TYPO3\CMS\Backend\Utility\BackendUtility;

// This checks permissions and exits if the users has no permission for entry.

class RecyclerModuleController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {

    public $doc;

    protected $relativePath;

    protected $pageRecord = array();

    protected $isAccessibleForCurrentUser = FALSE;

    protected $allowDelete = FALSE;

    protected $recordsPageLimit = 50;

    protected $pageRenderer;

    public function __construct() {
        $GLOBALS['LANG']->includeLLFile('EXT:recycler/mod1/locallang.xlf');
        $GLOBALS['BE_USER']->modAccess($GLOBALS['MCONF'], TRUE);
    }

    public function initialize() {
        parent::init();
        $this->doc = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Template\\DocumentTemplate');
        $this->doc->setModuleTemplate(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('recycler') . 'mod1/mod_template.html');
        $this->doc->backPath = $GLOBALS['BACK_PATH'];
        $this->doc->setExtDirectStateProvider();
        $this->pageRenderer = $this->doc->getPageRenderer();
        $this->relativePath = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('recycler');
        $this->pageRecord = BackendUtility::readPageAccess($this->id, $this->perms_clause);
        $this->isAccessibleForCurrentUser = $this->id && is_array($this->pageRecord) || !$this->id && $this->isCurrentUserAdmin();
        //don't access in workspace
        if ($GLOBALS['BE_USER']->workspace !== 0) {
            $this->isAccessibleForCurrentUser = FALSE;
        }
        //read configuration
        $modTS = $GLOBALS['BE_USER']->getTSConfig('mod.recycler');
        if ($this->isCurrentUserAdmin()) {
            $this->allowDelete = TRUE;
        } else {
            $this->allowDelete = $modTS['properties']['allowDelete'] == '1';
        }
        if (isset($modTS['properties']['recordsPageLimit']) && (int)$modTS['properties']['recordsPageLimit'] > 0) {
            $this->recordsPageLimit = (int)$modTS['properties']['recordsPageLimit'];
        }
    }

    public function render() {
        $this->content .= $this->doc->header($GLOBALS['LANG']->getLL('title'));
        $this->content .= '<p class="lead">' . $GLOBALS['LANG']->getLL('description') . '</p>';
        if ($this->isAccessibleForCurrentUser) {
            $this->loadHeaderData();
            // div container for renderTo
            $this->content .= '<div id="recyclerContent"></div>';
        } else {
            // If no access or if ID == zero
            $this->content .= $this->doc->spacer(10);
        }
    }

    public function flush() {
        $content = $this->doc->moduleBody($this->pageRecord, $this->getDocHeaderButtons(), $this->getTemplateMarkers());
        // Renders the module page
        $content = $this->doc->render($GLOBALS['LANG']->getLL('title'), $content);
        $this->content = NULL;
        $this->doc = NULL;
        echo $content;
    }

    protected function isCurrentUserAdmin() {
        return (bool) $GLOBALS['BE_USER']->user['admin'];
    }

    protected function loadHeaderData() {
        // Load CSS Stylesheets:
        $this->pageRenderer->addCssFile($this->relativePath . 'res/css/customExtJs.css');
        // Load Ext JS:
        $this->pageRenderer->loadExtJS();
        $this->pageRenderer->enableExtJSQuickTips();
        // Integrate dynamic JavaScript such as configuration or lables:
        $this->pageRenderer->addInlineSettingArray('Recycler', $this->getJavaScriptConfiguration());
        $this->pageRenderer->addInlineLanguageLabelArray($this->getJavaScriptLabels());
        // Load Recycler JavaScript:
        // Load Plugins
        $uxPath = $this->doc->backpath . 'js/extjs/ux/';
        $this->pageRenderer->addJsFile($uxPath . 'Ext.grid.RowExpander.js');
        $this->pageRenderer->addJsFile($uxPath . 'Ext.app.SearchField.js');
        $this->pageRenderer->addJsFile($uxPath . 'Ext.ux.FitToParent.js');
        // Load main script
        $this->pageRenderer->addJsFile($this->relativePath . 'res/js/t3_recycler.js');
    }

    protected function getJavaScriptConfiguration() {
        $configuration = array(
            'pagingSize' => $this->recordsPageLimit,
            'showDepthMenu' => 1,
            'startUid' => $this->id,
            'tableDefault' => 'pages',
            'renderTo' => 'recyclerContent',
            'isSSL' => \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SSL'),
            'deleteDisable' => $this->allowDelete ? 0 : 1,
            'depthSelection' => $this->getDataFromSession('depthSelection', 0),
            'tableSelection' => $this->getDataFromSession('tableSelection', 'pages'),
            'States' => $GLOBALS['BE_USER']->uc['moduleData']['web_recycler']['States']
        );
        return $configuration;
    }

    protected function getJavaScriptLabels() {
        $coreLabels = array(
            'title' => $GLOBALS['LANG']->getLL('title'),
            'path' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.path'),
            'table' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.table'),
            'depth' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_perm.xlf:Depth'),
            'depth_0' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_0'),
            'depth_1' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_1'),
            'depth_2' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_2'),
            'depth_3' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_3'),
            'depth_4' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_4'),
            'depth_infi' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.depth_infi')
        );
        $extensionLabels = $this->getJavaScriptLabelsFromLocallang('js.', 'label_');
        $javaScriptLabels = array_merge($coreLabels, $extensionLabels);
        return $javaScriptLabels;
    }

    protected function getJavaScriptLabelsFromLocallang($selectionPrefix = 'js.', $stripFromSelectionName = '') {
        $extraction = array();
        $labels = array_merge((array) $GLOBALS['LOCAL_LANG']['default'], (array) $GLOBALS['LOCAL_LANG'][$GLOBALS['LANG']->lang]);
        // Regular expression to strip the selection prefix and possibly something from the label name:
        $labelPattern = '#^' . preg_quote($selectionPrefix, '#') . '(' . preg_quote($stripFromSelectionName, '#') . ')?#';
        // Iterate through all locallang labels:
        foreach ($labels as $label => $value) {
            if (strpos($label, $selectionPrefix) === 0) {
                $key = preg_replace($labelPattern, '', $label);
                $extraction[$key] = $value;
            }
        }
        return $extraction;
    }

    protected function getDocHeaderButtons() {
        $buttons = array(
            'csh' => BackendUtility::cshItem('_MOD_web_func', '', $GLOBALS['BACK_PATH']),
            'shortcut' => $this->getShortcutButton(),
            'save' => ''
        );
        // SAVE button
        $buttons['save'] = '';
        return $buttons;
    }

    protected function getShortcutButton() {
        $result = '';
        if ($GLOBALS['BE_USER']->mayMakeShortcut()) {
            $result = $this->doc->makeShortcutIcon('', 'function', $this->MCONF['name']);
        }
        return $result;
    }

    protected function getTemplateMarkers() {
        $markers = array(
            'FUNC_MENU' => $this->getFunctionMenu(),
            'CONTENT' => $this->content,
            'TITLE' => $GLOBALS['LANG']->getLL('title')
        );
        return $markers;
    }

    protected function getFunctionMenu() {
        return BackendUtility::getFuncMenu(0, 'SET[function]', $this->MOD_SETTINGS['function'], $this->MOD_MENU['function']);
    }

    protected function getDataFromSession($identifier, $default = NULL) {
        $sessionData = &$GLOBALS['BE_USER']->uc['tx_recycler'];
        if (isset($sessionData[$identifier]) && $sessionData[$identifier]) {
            $data = $sessionData[$identifier];
        } else {
            $data = $default;
        }
        return $data;
    }

}