classes/plwizard.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2008 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(PlPage &$page, $id);
  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     private $userdata = array();
  68
  69     protected $name;
  70     protected $layout;
  71     protected $stateless;
  72     protected $ajax;
  73
  74     protected $pages;
  75     protected $titles;
  76     protected $lookup;
  77     protected $inv_lookup;
  78
  79     public function __construct($name, $layout, $stateless = false, $ajax = true)
  80     {
  81         $this->name      = 'wiz_' . $name;
  82         $this->layout    = $layout;
  83         $this->stateless = $stateless;
  84         $this->pages  = array();
  85         $this->lookup = array();
  86         $this->titles = array();
  87         $this->ajax   = $ajax;
  88         if (!isset($_SESSION[$this->name])) {
  89             $_SESSION[$this->name] = array();
  90             $_SESSION[$this->name . '_page']  = null;
  91             $_SESSION[$this->name . '_stack'] = array();
  92         }
  93     }
  94
  95     public function addPage($class, $title, $id = null)
  96     {
  97         if ($id == null) {
  98             $id = count($this->pages);
  99         }
 100         $this->lookup[$id]  = count($this->pages);
 101         $this->inv_lookup[] = $id;
 102         $this->pages[]      = $class;
 103         $this->titles[]     = $title;
 104     }
 105
 106     public function addUserData($name, $value)
 107     {
 108         $this->userdata[$name] = $value;
 109     }
 110
 111     public function getUserData($name, $default = null)
 112     {
 113         return $this->userdata[$name];
 114     }
 115
 116     public function set($varname, $value)
 117     {
 118         $_SESSION[$this->name][$varname] = $value;
 119     }
 120
 121     public function get($varname, $default = null)
 122     {
 123         return isset($_SESSION[$this->name][$varname]) ?
 124                     $_SESSION[$this->name][$varname] : $default;
 125     }
 126
 127     public function v($varname, $default = "")
 128     {
 129         return $this->get($varname, $default);
 130     }
 131
 132     public function i($varname, $default = 0)
 133     {
 134         return (int)$this->get($varname, $default);
 135     }
 136
 137     public function clear($varname = null)
 138     {
 139         if (is_null($varname)) {
 140             $_SESSION[$this->name] = array();
 141         } else {
 142             unset($_SESSION[$this->name][$varname]);
 143         }
 144         $_SESSION[$this->name . '_page'] = null;
 145     }
 146
 147     private function getPage($id)
 148     {
 149         $page = $this->pages[$id];
 150         return new $page($this);
 151     }
 152
 153     public function apply(PlPage &$smarty, $baseurl, $pgid = null, $mode = 'normal')
 154     {
 155         if ($this->stateless && (isset($this->lookup[$pgid]) || isset($this->pages[$pgid]))) {
 156             $curpage = is_numeric($pgid) ? $pgid : $this->lookup[$pgid];
 157         } else if ($this->stateless && is_null($pgid)) {
 158             $curpage = 0;
 159         } else {
 160             $curpage = $_SESSION[$this->name . '_page'];
 161         }
 162         $oldpage = $curpage;
 163
 164         // Process the previous page
 165         if (Post::has('valid_page')) {
 166             S::assert_xsrf_token();
 167
 168             $page = $this->getPage(Post::i('valid_page'));
 169             $curpage = Post::i('valid_page');
 170             $next = $page->process();
 171             $last = $curpage;
 172             switch ($next) {
 173               case PlWizard::FIRST_PAGE:
 174                 $curpage = 0;
 175                 break;
 176               case PlWizard::PREVIOUS_PAGE:
 177                 if (!$this->stateless && count($_SESSION[$this->name . '_stack'])) {
 178                     $curpage = array_pop($_SESSION[$this->name . '_stack']);
 179                 } elseif ($curpage && $this->stateless) {
 180                     $curpage--;
 181                 } else {
 182                     $curpage = 0;
 183                 }
 184                 break;
 185               case PlWizard::NEXT_PAGE:
 186                 if ($curpage < count($this->pages) - 1) {
 187                     $curpage++;
 188                 }
 189                 break;
 190               case PlWizard::LAST_PAGE:
 191                 $curpage = count($this->pages) - 1;
 192                 break;
 193               case PlWizard::CURRENT_PAGE: break; // don't change the page
 194               default:
 195                 $curpage = is_numeric($next) ? $next : $this->lookup[$next];
 196                 break;
 197             }
 198             if (!$this->stateless) {
 199                 array_push($_SESSION[$this->name . '_stack'], $last);
 200             }
 201         }
 202         if (is_null($curpage)) {
 203             $curpage = 0;
 204         }
 205
 206         // Prepare the page
 207         $_SESSION[$this->name . '_page'] = $curpage;
 208         if ($curpage != $oldpage) {
 209             pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage]);
 210         } else if (!isset($page)) {
 211             $page = $this->getPage($curpage);
 212         }
 213         if ($mode == 'ajax') {
 214             header('Content-Type: text/html; charset=utf-8');
 215             $smarty->changeTpl($page->template(), NO_SKIN);
 216         } else {
 217             $smarty->changeTpl($this->layout);
 218         }
 219         $smarty->assign('pages', $this->titles);
 220         $smarty->assign('current', $curpage);
 221         $smarty->assign('lookup', $this->inv_lookup);
 222         $smarty->assign('stateless', $this->stateless);
 223         $smarty->assign('wiz_baseurl', $baseurl);
 224         $smarty->assign('wiz_ajax', $this->ajax);
 225         $smarty->assign('tab_width', (int)(99 / count($this->pages)));
 226         $smarty->assign('wiz_page', $page->template());
 227         $smarty->assign('pl_no_errors', true);
 228         $page->prepare($smarty, isset($this->inv_lookup[$curpage]) ? $this->inv_lookup[$curpage] : $curpage);
 229     }
 230 }
 231
 232 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 233 ?>