classes/plwizard.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2007 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  **************************************************************************/
  21
  22 /** A Wizard Page is a page of a wizard. It is a self-contained step which
  23  * handles both the creation and initialisation of the step (by using the
  24  * Wizard global state, if needed) and the processing of the action the
  25  * user made on it.
  26  */
  27 interface PlWizardPage
  28 {
  29     /** Build a new instance of the class
  30      * associated with the given wizard master.
  31      */
  32     public function __construct(PlWizard &$wiz);
  33
  34     /** Return the name of the templace describing the page.
  35      */
  36     public function template();
  37
  38     /** Prepare the page by assigning to it any useful value.
  39      */
  40     public function prepare(PlatalPage &$page);
  41
  42     /** Process information resulting of the application of the page.
  43      * This function must return a clue indicating the next page to show.
  44      * This clue can be either a page id, a page number or a navigation
  45      * id (PlWizard::FIRST_PAGE, PlWizard::NEXT_PAGE, PlWizard::CURRENT_PAGE
  46      *  PlWizard::PREVIOUS_PAGE, PlWizard::LAST_PAGE).
  47      */
  48     public function process();
  49 }
  50
  51 /** A PlWizard is a set of pages through which the user can navigate,
  52  * his action on a page determining which the next one will be.
  53  *
  54  * A Wizard can either a stateless wizard (which is only a set of
  55  * independent pages through which the user can easily navigate) or
  56  * stateful (a suite of steps where each step gives clue for the next
  57  * one).
  58  */
  59 class PlWizard
  60 {
  61     const FIRST_PAGE    = 'bt_first';
  62     const NEXT_PAGE     = 'bt_next';
  63     const CURRENT_PAGE  = 'bt_current';
  64     const PREVIOUS_PAGE = 'bt_previous';
  65     const LAST_PAGE     = 'bt_last';
  66
  67     protected $name;
  68     protected $layout;
  69     protected $stateless;
  70
  71     protected $pages;
  72     protected $titles;
  73     protected $lookup;
  74     protected $inv_lookup;
  75
  76     public function __construct($name, $layout, $stateless = false)
  77     {
  78         $this->name      = 'wiz_' . $name;
  79         $this->layout    = $layout;
  80         $this->stateless = $stateless;
  81         $this->pages  = array();
  82         $this->lookup = array();
  83         $this->titles = array();
  84         if (!isset($_SESSION[$this->name])) {
  85             $_SESSION[$this->name] = array();
  86             $_SESSION[$this->name . '_page']  = null;
  87             $_SESSION[$this->name . '_stack'] = array();
  88         }
  89     }
  90
  91     public function addPage($class, $title, $id = null)
  92     {
  93         if ($id == null) {
  94             $id = count($this->pages);
  95         }
  96         $this->lookup[$id]  = count($this->pages);
  97         $this->inv_lookup[] = $id;
  98         $this->pages[]      = $class;
  99         $this->titles[]     = $title;
 100     }
 101
 102     public function set($varname, $value)
 103     {
 104         $_SESSION[$this->name][$varname] = $value;
 105     }
 106
 107     public function get($varname, $default = null)
 108     {
 109         return isset($_SESSION[$this->name][$varname]) ?
 110                     $_SESSION[$this->name][$varname] : $default;
 111     }
 112
 113     public function v($varname, $default = "")
 114     {
 115         return $this->get($varname, $default);
 116     }
 117
 118     public function i($varname, $default = 0)
 119     {
 120         return (int)$this->get($varname, $default);
 121     }
 122
 123     public function clear($varname = null)
 124     {
 125         if (is_null($varname)) {
 126             $_SESSION[$this->name] = array();
 127         } else {
 128             unset($_SESSION[$this->name][$varname]);
 129         }
 130         $_SESSION[$this->name . '_page'] = null;
 131     }
 132
 133     private function getPage($id)
 134     {
 135         $page = $this->pages[$id];
 136         return new $page($this);
 137     }
 138
 139     public function apply(PlatalPage &$smarty, $baseurl, $pgid = null)
 140     {
 141         if ($this->stateless && (isset($this->lookup[$pgid]) || isset($this->pages[$pgid]))) {
 142             $curpage = is_numeric($pgid) ? $pgid : $this->lookup[$pgid];
 143         } else if ($this->stateless && is_null($pgid)) {
 144             $curpage = 0;
 145         } else {
 146             $curpage = $_SESSION[$this->name . '_page'];
 147         }
 148         $oldpage = $curpage;
 149
 150         // Process the previous page
 151         if (Post::has('valid_page')) {
 152             $page = $this->getPage(Post::i('valid_page'));
 153             $curpage = Post::i('valid_page');
 154             $next = $page->process();
 155             $last = $curpage;
 156             switch ($next) {
 157               case PlWizard::FIRST_PAGE:
 158                 $curpage = 0;
 159                 break;
 160               case PlWizard::PREVIOUS_PAGE:
 161                 if (!$this->stateless && count($_SESSION[$this->name . '_stack'])) {
 162                     $curpage = array_pop($_SESSION[$this->name . '_stack']);
 163                 } elseif ($curpage && $this->stateless) {
 164                     $curpage--;
 165                 } else {
 166                     $curpage = 0;
 167                 }
 168                 break;
 169               case PlWizard::NEXT_PAGE:
 170                 if ($curpage < count($this->pages) - 1) {
 171                     $curpage++;
 172                 }
 173                 break;
 174               case PlWizard::LAST_PAGE:
 175                 $curpage = count($this->pages) - 1;
 176                 break;
 177               case PlWizard::CURRENT_PAGE: break; // don't change the page
 178               default:
 179                 $curpage = is_numeric($next) ? $next : $this->lookup[$next];
 180                 break;
 181             }
 182             if (!$this->stateless) {
 183                 array_push($_SESSION[$this->name . '_stack'], $last);
 184             }
 185         }
 186         if (is_null($curpage)) {
 187             $curpage = 0;
 188         }
 189
 190         // Prepare the page
 191         $_SESSION[$this->name . '_page'] = $curpage;
 192         if ($curpage != $oldpage) {
 193             pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage]);
 194         } else if (!isset($page)) {
 195             $page = $this->getPage($curpage);
 196         }
 197         $smarty->changeTpl($this->layout);
 198         $smarty->assign('pages', $this->titles);
 199         $smarty->assign('current', $curpage);
 200         $smarty->assign('lookup', $this->inv_lookup);
 201         $smarty->assign('stateless', $this->stateless);
 202         $smarty->assign('wiz_baseurl', $baseurl);
 203         $smarty->assign('tab_width', (int)(99 / count($this->pages)));
 204         $smarty->assign('wiz_page', $page->template());
 205         $smarty->assign('xorg_no_errors', true);
 206         $page->prepare($smarty);
 207     }
 208 }
 209
 210 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 211 ?>