class.tx_funcwizards_webfunc.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Contains a class for the Wizard function in the Web>Info module
 *
 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
 * XHTML compliant
 *
 * @author  Kasper Skårhøj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *   66: class tx_funcwizards_webfunc extends t3lib_extobjbase
 *   78:     function init(&$pObj,$conf)
 *   92:     function modMenu()
 *  111:     function main()
 *
 * TOTAL FUNCTIONS: 3
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */

/**
 * The Wizard function in the Web>Info module
 * Creates a framework for adding wizard sub-sub-modules under the Wizard function in Web>Info
 *
 * @author  Kasper Skårhøj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage tx_funcwizardswebfunc
 */
class tx_funcwizards_webfunc extends t3lib_extobjbase {
    var $function_key = 'wiz';

    /**
     * Initialize.
     * Calls parent init function and then the handleExternalFunctionValue() function from the parent class
     *
     * @param   object      A reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
     * @param   array       The configuration set for this module - from global array TBE_MODULES_EXT
     * @return  void
     * @see t3lib_extobjbase::handleExternalFunctionValue(), t3lib_extobjbase::init()
     */
    function init(&$pObj,$conf) {
            // OK, handles ordinary init. This includes setting up the menu array with ->modMenu
        parent::init($pObj,$conf);

            // 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!!!
        $this->handleExternalFunctionValue();
    }

    /**
     * Modifies parent objects internal MOD_MENU array, adding items this module needs.
     *
     * @return  array       Items merged with the parent objects.
     * @see t3lib_extobjbase::init()
     */
    function modMenu()  {
        global $LANG;

        $modMenuAdd = array(
            $this->function_key => array()
        );

        $modMenuAdd[$this->function_key] = $this->pObj->mergeExternalItems($this->pObj->MCONF['name'],$this->function_key,$modMenuAdd[$this->function_key]);
        $modMenuAdd[$this->function_key] = t3lib_BEfunc::unsetMenuItems($this->pObj->modTSconfig['properties'],$modMenuAdd[$this->function_key],'menu.'.$this->function_key);

        return $modMenuAdd;
    }

    /**
     * Creation of the main content. Calling extObjContent() to trigger content generation from the sub-sub modules
     *
     * @return  string      The content
     * @see t3lib_extobjbase::extObjContent()
     */
    function main() {
        global $SOBE,$LANG;

        $menu= $LANG->getLL('wiz_lWizards',1).': '.t3lib_BEfunc::getFuncMenu($this->pObj->id,'SET[wiz]',$this->pObj->MOD_SETTINGS['wiz'],$this->pObj->MOD_MENU['wiz']);
        $theOutput.=$this->pObj->doc->section('','<span class="nobr">'.$menu.'</span>');

        $content = '';
        $content.=$theOutput;
        $content.=$this->pObj->doc->spacer(5);
        $content.=$this->extObjContent();

        return $content;
    }
}

if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/func_wizards/class.tx_funcwizards_webfunc.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/func_wizards/class.tx_funcwizards_webfunc.php']);
}
?>