wizard-james.class.php

Go to the documentation of this file.

<?

include_once("core/html/dialog-james.class.php");
include_once("core/i18n/I18N.class.php");

define ("WIZARD_START_TEXT",gettext(" Start "));
define ("WIZARD_START_NAME", "start");
define ("WIZARD_START_TYPE", "submit");
define ("WIZARD_START_ONCLICK", "");

define ("WIZARD_END_TEXT",gettext(" End "));
define ("WIZARD_END_NAME", "end");
define ("WIZARD_END_TYPE", "submit");
define ("WIZARD_END_ONCLICK", "");

define ("WIZARD_NEXT_TEXT",gettext(" Next "));
define ("WIZARD_NEXT_NAME", "next");
define ("WIZARD_NEXT_TYPE", "submit");
define ("WIZARD_NEXT_ONCLICK", "");



class WizardJames{

        var $debug = "ON";
                
        var $dialog;
        var $end;
        var $endCaption;
        var $steps;
        var $curStep;
        var $title;
        var $vars;
        var $error = false;
        var $errorMsg;

        function WizardJames($title=0){
                $this->steps = array();
                $this->vars = array();

                
                // Following If is refered whereas we are starting 
                // the wizard.

                // NOTE: When we push the button, we have a variable called
                // state with value execution; this means that we have to execute
                // the handling function.

                if ($title){
                        // If title exist, we are starting the wizard
                        // so we must initialize all the stuff
                        $this->title = $title;
                        $this->end = 0;
                        $this->dialog = new DialogJames($title);
                        $this->AddStep($_SERVER["PHP_SELF"]);
                        $this->SetCurrentStep();
                        $this->SaveState();
                }else{
                        // If title NOT exist, we are "in the middle" of the wizard
                        // so we must load state from sesion
                        $this->LoadState();
                        $this->SetCurrentStep();
                        $this->GetRequestVars();
                        //$this->Debug("WizardJames: this",$this);
                        if($_REQUEST["WJ_ExecStep"] == $this->curStep){         
                                $this->error = !$this->ExecHandler();
                                if(!$this->error){              
                                        $this->RedirectNextStep();
                                }
                        }
                }
        }

        function RedirectNextStep(){
                
                $nextURL = $this->GetNextURLStep();

                $this->curStep++;
                $this->SaveState();

                header("location: ".$nextURL);
                die();

        }


        function NumSteps(){
                return count($this->steps);
        }

        function SetCurrentStep(){
                $this->curStep = array_search(basename($_SERVER["PHP_SELF"]),$this->steps);
                if ( ($this->curStep < 0) || ($this->curStep > $this->NumSteps()) )
                        die(gettext("Error getting the Step number"));
        }

        function GetCurURLStep(){
                return $this->steps[$this->curStep];
        }

        
        // Returns the next "nominal" URL, it won't be
        // loaded until "header" 
        function GetNextURLStep(){
                $NextURL = $this->GetCurURLStep(); 
                if (!$this->IsLastStep())
                        $NextURL =  $this->steps[$this->curStep+1];
                else{
                        if ($this->end)
                                $NextURL = $this->end;
                }
                return $NextURL;
        }

        // Returns the next Page that will be loaded, perharps
        // only for make a "header" statement that will redirect
        // to another page
        // At the moment, is for working around the first Step.
        function GetRealNextURLStep(){
                if (!$this->IsFirstStep())
                        $RealNextURL = $this->GetCurURLStep();
                else{
                        $RealNextURL = $this->GetNextURLStep();
                }
                return $RealNextURL;
        }


        function IsFirstStep(){
                return ($this->curStep == 0);
        }

        function IsLastStep(){
                return ($this->curStep == $this->NumSteps()-1);
        }

        function PrintHeader(){ 
                $this->SetHeader();
                echo "<form enctype='multipart/form-data' method='POST' action='".$this->GetRealNextURLStep()."'>";
                echo "<input type='hidden' name='WJ_ExecStep' value='".$this->curStep."'>";
                $this->dialog->PrintHeader();
                $this->PrintError(); //... if needed
        }       

        function PrintError(){
                if($this->error){
                        echo "<hr class='black'>";
                        if($this->errorMsg){
                                echo "<center><b>Missing or wrong data, please correct mistake; error details:</b></center>";
                                echo "<br>";
                                echo "<font class='error'>".$this->errorMsg."</font>";
                                echo "<br>";
                                $this->errorMsg = "";
                        }else{
                                echo "<center><b>Missing or wrong data, please correct mistake</b></center>";
                        }

                        echo "<hr class='black'>";
                        $this->error = false;
                }
        }

        function SetEnd($end,$caption=""){
                $this->end = $end;
                if ($caption)
                        $this->endCaption = $caption;
        }

        function SetFoot(){
                if ($this->IsLastStep()){
                        $text = WIZARD_END_TEXT;
                        if($this->endCaption)
                                $text = $this->endCaption;
                        $this->dialog->setOK($text,WIZARD_END_NAME,WIZARD_END_TYPE,WIZARD_END_ONCLICK);
                }else if ($this->IsFirstStep()) {
                        $this->dialog->setOK(WIZARD_START_TEXT,WIZARD_START_NAME,WIZARD_START_TYPE,WIZARD_START_ONCLICK);
                }else{
                        $this->dialog->setOK(WIZARD_NEXT_TEXT,WIZARD_NEXT_NAME,WIZARD_NEXT_TYPE,WIZARD_NEXT_ONCLICK);
                }
        }

        function SetHeader(){
                $this->dialog->title    = $this->title
                                        . " (".gettext("Step")." "
                                        . ($this->curStep+1)
                                        . " ".gettext("of")." "
                                        . $this->NumSteps()
                                        . ")";
        }

        function PrintFoot(){
                $this->SetFoot();
                $this->dialog->PrintFoot();
                echo "</form>";
                $this->SaveState();
        }       

        function GetSecVar($name){
                if ($this->vars[$name])
                        return $this->vars[$name];
                else
                        return "none";
        }

        function GetVar($name){
                return $this->vars[$name];              
        }

        function SetVar($name,$value){
                $this->vars[$name] = $value;            
        }

        function PrintVar($name,$type,$default=""){
                if($this->GetVar($name)){
                        $default = $this->GetVar($name);
                }
                echo "<input name='WJVar[$name]' type='$type' value='$default' class='wizard'>";
        }

        function SaveState(){
                // Save data (and state) of wizard 
                @session_start();
                $_SESSION["WizardJames"] = $this;
        }

        function LoadState(){
                // Save data (and state) of wizard 
                @session_start();

                //$this->Debug("LoadState",$_SESSION);

                $wizard = $_SESSION["WizardJames"];
                if ($wizard){
                        $this->copyAttributes($wizard);
                }else{
                        // If there isn't in session... something wrong is
                        // going on...
                        die(gettext("Couldn't Load Wizard State and Information from Session. Please Return to first page."));
                }
        }

        function copyAttributes($obj){

                
                // Elegant copy of attributes...
                $classAttributes = get_class_vars(get_class($this));
                foreach ($classAttributes as $name=>$value) {
                        $estatement = '$this->'.$name.' = $obj->'.$name.';';
                        eval($estatement);
                }       

                // In some versions of PHP above code doesn't work so...
                if($this->title != $obj->title){

                        // We do it by "brute" style...
                        $this->title = $obj->title;
                        $this->end = $obj->end;
                        $this->endCaption = $obj->endCaption;
                        $this->vars = $obj->vars;
                        $this->dialog = $obj->dialog;
                        $this->steps = $obj->steps;
                }

        }

        function GetRequestVars(){

                if($_REQUEST["WJVar"]){
                        foreach($_REQUEST["WJVar"] as $var=>$val){
                                $this->vars[$var] = $val;
                        }
                }
                

        }

        function AddStep($phpfile,$i=-1){
                // A little of caution...
                $phpfile = basename($phpfile);

                if ($i>=0)
                        $this->steps[$i] = $phpfile;
                else
                        $this->steps[] = $phpfile;
        }

        function ExecHandler(){
                if(function_exists("WizardHandler")){
                        return WizardHandler(&$this);           
                }else{
                        return true;
                }       
        }


        function Debug($pre,$v){
                
                if ($this->debug == "ON"){
                        echo "<pre style='font-size: 11px'>";
                        echo $pre.":\n";
                        print_r($v);
                        echo "</pre>";
                }
        }       

        function Dump(){
                echo "<pre style='font-size: 11px'>";
                print_r($this);
                echo "</pre>";
        }       
}

?>

---