Peter M. Groen / knowledgetree

<?php
/**
* Step Base Class.
*
* KnowledgeTree Community Edition
* Document Management Made Simple
* Copyright(C) 2008,2009 KnowledgeTree Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* This program 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.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
*
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
* California 94120-7775, or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
*
* @copyright 2008-2009, KnowledgeTree Inc.
* @license GNU General Public License version 3
* @author KnowledgeTree Team
* @package Installer
* @version Version 0.1
*/

class StepBase {
	/**
	* Session salt
	*
	* @author KnowledgeTree Team
	* @access public
	* @var string
	*/
    protected $salt = '';
    
	/**
	* List of variables to be loaded to template
	*
	* @author KnowledgeTree Team
	* @access protected
	* @var array
	*/
    protected $temp_variables = array();
    
	/**
	* List of errors encountered by step
	*
	* @author KnowledgeTree Team
	* @access protected
	* @var array
	*/
    protected $error = array();

	/**
	* List of warnings encountered by step
	*
	* @author KnowledgeTree Team
	* @access protected
	* @var array
	*/
    protected $warnings = array();
    
	/**
	* Flag to store class information in session
	*
	* @author KnowledgeTree Team
	* @access public
	* @var boolean
	*/
    protected $storeInSession = false;
    
	/**
	* Step order
	*
	* @author KnowledgeTree Team
	* @access public
	* @var boolean
	*/
    protected $order = false;
    
	/**
	* Flag if step needs to run silently
	*
	* @author KnowledgeTree Team
	* @access public
	* @var boolean
	*/
    protected $silent = false;
    
	/**
	* Flag if step needs to show confirm page first
	*
	* @author KnowledgeTree Team
	* @access public
	* @var boolean
	*/
    public $displayFirst = false;
    
	/**
	* Reference to utility object
	*
	* @author KnowledgeTree Team
	* @access protected
	* @var object
	*/
    public $util;
    
	/**
	* Returns step state
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return string
	*/
    public function doStep() {
        return '';
    }

    public function displayFirst() {
    	return $this->displayFirst;
    }
    
    /**
	* Returns step variables
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return array
	*/
    public function getStepVars() {
        return $this->temp_variables;
    }

	/**
	* Returns step errors
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return array
	*/
    public function getErrors() {
        return $this->error;
    }

	/**
	* Returns step errors
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return array
	*/
    public function getWarnings() {
        return $this->warnings;
    }
    
	/**
	* Load default step values
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return void
	*/
    public function loadDefaults() {
		
    }

	/**
	* Return default step values
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return array
	*/
    public function getDefaults() {
        return array();
    }

	/**
	* Checks if edit button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    public function edit() {
        if(isset($_POST['Edit'])) {
            return true;
        }

        return false;
    }

	/**
	* Checks if next button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    public function next() {
        if(isset($_POST['Next'])) {
            return true;
        }

        return false;
    }

	/**
	* Checks if previous button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    public function previous() {
        if(isset($_POST['Previous'])) {
            return true;
        }

        return false;
    }

	/**
	* Checks if skip button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    public function skip() {
        if(isset($_POST['Skip'])) {
            return true;
        }

        return false;
    }
    
	/**
	* Checks if Confirm button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    function confirm() {
        if(isset($_POST['Confirm'])) {
            return true;
        }

        return false;
    }

	/**
	* Checks if Install button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    function install() {
        if(isset($_POST['Install'])) {
            return true;
        }

        return false;
    }

	/**
	* Checks if Clean install button has been clicked
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return boolean
	*/
    function migrate() {
    	if(isset($_POST['installtype'])) {
        	if($_POST['installtype'] == "Upgrade Installation") {
            	return true;
        	}
    	}
    	
        return false;
    }
    
	/**
	* Checks if we are currently in this class step
	*
	* @author KnowledgeTree Team
	* @param string
	* @access public
	* @return boolean
	*/
    public function inStep($name) {
    	if(!isset($_GET['step_name'])) return false;
        if($_GET['step_name'] == $name)
            return true;
        return false;
    }
    
	/**
	* Get session data from package
	*
	* @author KnowledgeTree Team
	* @params none
	* @access private
	* @return boolean
	*/
    public function getDataFromPackage($package, $class) {
    	if(empty($_SESSION[$package][$class])) {
    		return false;
    	}
    	
    	return $_SESSION[$package][$class];
    }
    
	/**
	* Safer way to return post data
	*
	* @author KnowledgeTree Team
	* @params SimpleXmlObject $simplexml
	* @access public
	* @return void
	*/
    public function getPostSafe($key) {
    	return isset($_POST[$key]) ? $_POST[$key] : "";
    }
    
	/**
	* Safer way to return post data
	*
	* @author KnowledgeTree Team
	* @params SimpleXmlObject $simplexml
	* @access public
	* @return void
	*/
    public function getPostBoolean($key) {
    	return isset($_POST[$key]) ? $_POST[$key] : false;
    }
    
	/**
	* Runs step install if required
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return void
	*/
    public function installStep() {
		return '';
    }
    
    /**
     * Return whether or not to store a step information in session
     * 
     * @author KnowledgeTree Team
     * @param none
     * @access public
     * @return boolean
     */
    public function storeInSession() {
    	return $this->storeInSession;
    }
    
    public function setPostConfig() {
    	return '';
    }
    
    /**
     * Return whether or not to a step has to be in silent mode
     * 
     * @author KnowledgeTree Team
     * @param none
     * @access public
     * @return boolean
     */
    public function silentMode() {
    	return $this->silent;
    }
    
	/**
	* Set step errors
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return array
	*/
    public function setErrors($error) {
        $this->error = $error;
    }
    
	/**
	* Is the installation 
	*
	* @author KnowledgeTree Team
	* @param none
	* @access public
	* @return string
	*/
    public function isCe() {
    	if($this->util->getVersionType() == "community")
    		return true;
    	return false;
    }

    public function storeSilent() {
    	return true;
    }
}

?>