typo3/sysext/func_wizards/Classes/Controller/WebFunctionWizardsBaseController.php

   1 <?php
   2 namespace TYPO3\CMS\FuncWizards\Controller;
   3
   4 /***************************************************************
   5  *  Copyright notice
   6  *
   7  *  (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
   8  *  All rights reserved
   9  *
  10  *  This script is part of the TYPO3 project. The TYPO3 project is
  11  *  free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  The GNU General Public License can be found at
  17  *  http://www.gnu.org/copyleft/gpl.html.
  18  *  A copy is found in the textfile GPL.txt and important notices to the license
  19  *  from the author is found in LICENSE.txt distributed with these scripts.
  20  *
  21  *
  22  *  This script is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  This copyright notice MUST APPEAR in all copies of the script!
  28  ***************************************************************/
  29 /**
  30  * Contains a class for the Wizard function in the Web>Info module
  31  *
  32  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  33  * XHTML compliant
  34  *
  35  * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  36  */
  37 /**
  38  * The Wizard function in the Web>Info module
  39  * Creates a framework for adding wizard sub-sub-modules under the Wizard function in Web>Info
  40  *
  41  * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  42  * @package TYPO3
  43  * @subpackage tx_funcwizardswebfunc
  44  */
  45 class WebFunctionWizardsBaseController extends \TYPO3\CMS\Backend\Module\AbstractFunctionModule {
  46
  47         /**
  48          * @todo Define visibility
  49          */
  50         public $function_key = 'wiz';
  51
  52         /**
  53          * Initialize.
  54          * Calls parent init function and then the handleExternalFunctionValue() function from the parent class
  55          *
  56          * @param object $pObj A reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
  57          * @param array $conf The configuration set for this module - from global array TBE_MODULES_EXT
  58          * @return void
  59          * @see t3lib_extobjbase::handleExternalFunctionValue(), t3lib_extobjbase::init()
  60          * @todo Define visibility
  61          */
  62         public function init(&$pObj, $conf) {
  63                 // OK, handles ordinary init. This includes setting up the menu array with ->modMenu
  64                 parent::init($pObj, $conf);
  65                 // Making sure that any further external classes are added to the include_once array. Notice that inclusion happens twice in the main script because of this!!!
  66                 $this->handleExternalFunctionValue();
  67         }
  68
  69         /**
  70          * Modifies parent objects internal MOD_MENU array, adding items this module needs.
  71          *
  72          * @return array Items merged with the parent objects.
  73          * @see t3lib_extobjbase::init()
  74          * @todo Define visibility
  75          */
  76         public function modMenu() {
  77                 global $LANG;
  78                 $modMenuAdd = array(
  79                         $this->function_key => array()
  80                 );
  81                 $modMenuAdd[$this->function_key] = $this->pObj->mergeExternalItems($this->pObj->MCONF['name'], $this->function_key, $modMenuAdd[$this->function_key]);
  82                 $modMenuAdd[$this->function_key] = \TYPO3\CMS\Backend\Utility\BackendUtility::unsetMenuItems($this->pObj->modTSconfig['properties'], $modMenuAdd[$this->function_key], 'menu.' . $this->function_key);
  83                 return $modMenuAdd;
  84         }
  85
  86         /**
  87          * Creation of the main content. Calling extObjContent() to trigger content generation from the sub-sub modules
  88          *
  89          * @return string The content
  90          * @see t3lib_extobjbase::extObjContent()
  91          * @todo Define visibility
  92          */
  93         public function main() {
  94                 global $SOBE, $LANG;
  95                 $menu = $LANG->getLL('wiz_lWizards', 1) . ': ' . \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncMenu($this->pObj->id, 'SET[wiz]', $this->pObj->MOD_SETTINGS['wiz'], $this->pObj->MOD_MENU['wiz']);
  96                 $theOutput .= $this->pObj->doc->section('', '<span class="nobr">' . $menu . '</span>');
  97                 $content = '';
  98                 $content .= $theOutput;
  99                 $content .= $this->pObj->doc->spacer(20);
 100                 $content .= $this->extObjContent();
 101                 return $content;
 102         }
 103
 104 }
 105
 106
 107 ?>