CRM/Core/StateMachine.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Core StateMachine. All statemachines subclass for the core one
  38  * for functionality specific to their needs.
  39  *
  40  * A statemachine keeps track of differnt states and forms for a
  41  * html quickform controller.
  42  *
  43  */
  44 class CRM_Core_StateMachine {
  45
  46   /**
  47    * The controller of this state machine
  48    * @var object
  49    */
  50   protected $_controller;
  51
  52   /**
  53    * The list of states that belong to this state machine
  54    * @var array
  55    */
  56   protected $_states;
  57
  58   /**
  59    * The list of pages that belong to this state machine. Note
  60    * that a state and a form have a 1 <-> 1 relationship. so u
  61    * can always derive one from the other
  62    * @var array
  63    */
  64   protected $_pages;
  65
  66   /**
  67    * The names of the pages
  68    *
  69    * @var array
  70    */
  71   protected $_pageNames;
  72
  73   /**
  74    * The mode that the state machine is operating in
  75    * @var int
  76    */
  77   protected $_action = NULL;
  78
  79   /**
  80    * The display name for this machine
  81    * @var string
  82    */
  83   protected $_name = NULL;
  84
  85   /**
  86    * Class constructor
  87    *
  88    * @param object $controller
  89    *   The controller for this state machine.
  90    *
  91    * @param \const|int $action
  92    *
  93    * @return \CRM_Core_StateMachine
  94   @access public
  95    */
  96   public function __construct(&$controller, $action = CRM_Core_Action::NONE) {
  97     $this->_controller = &$controller;
  98     $this->_action = $action;
  99
 100     $this->_states = array();
 101   }
 102
 103   /**
 104    * Getter for name
 105    *
 106    * @return string
 107    */
 108   public function getName() {
 109     return $this->_name;
 110   }
 111
 112   /**
 113    * Setter for name
 114    *
 115    * @param string
 116    *
 117    * @return void
 118    */
 119   public function setName($name) {
 120     $this->_name = $name;
 121   }
 122
 123   /**
 124    * Do a state transition jump. Currently only supported types are
 125    * Next and Back. The other actions (Cancel, Done, Submit etc) do
 126    * not need the state machine to figure out where to go
 127    *
 128    * @param CRM_Core_Form $page
 129    *   The current form-page.
 130    * @param string $actionName
 131    *   Current action name, as one Action object can serve multiple actions.
 132    * @param string $type
 133    *   The type of transition being requested (Next or Back).
 134    *
 135    * @return void
 136    */
 137   public function perform(&$page, $actionName, $type = 'Next') {
 138     // save the form values and validation status to the session
 139     $page->isFormBuilt() or $page->buildForm();
 140
 141     $pageName = $page->getAttribute('name');
 142     $data = &$page->controller->container();
 143
 144     $data['values'][$pageName] = $page->exportValues();
 145     $data['valid'][$pageName] = $page->validate();
 146
 147     // if we are going to the next state
 148     // Modal form and page is invalid: don't go further
 149     if ($type == 'Next' && !$data['valid'][$pageName]) {
 150       return $page->handle('display');
 151     }
 152
 153     $state = &$this->_states[$pageName];
 154
 155     // dont know how or why we landed here so abort and display
 156     // current page
 157     if (empty($state)) {
 158       return $page->handle('display');
 159     }
 160
 161     // the page is valid, process it if we are jumping to the next state
 162     if ($type == 'Next') {
 163       $page->mainProcess();
 164       // we get the state again, since postProcess might have changed it
 165       // this bug took me forever to find :) Lobo
 166       $state = &$this->_states[$pageName];
 167       $state->handleNextState($page);
 168     }
 169     else {
 170       $state->handleBackState($page);
 171     }
 172   }
 173
 174   /**
 175    * Helper function to add a State to the state machine
 176    *
 177    * @param string $name
 178    *   The internal name.
 179    * @param int $type
 180    *   The type of state (START|FINISH|SIMPLE).
 181    * @param object $prev
 182    *   The previous page if any.
 183    * @param object $next
 184    *   The next page if any.
 185    *
 186    * @return void
 187    */
 188   public function addState($name, $type, $prev, $next) {
 189     $this->_states[$name] = new CRM_Core_State($name, $type, $prev, $next, $this);
 190   }
 191
 192   /**
 193    * Given a name find the corresponding state
 194    *
 195    * @param string $name
 196    *   The state name.
 197    *
 198    * @return object the state object
 199    */
 200   public function find($name) {
 201     if (array_key_exists($name, $this->_states)) {
 202       return $this->_states[$name];
 203     }
 204     else {
 205       return NULL;
 206     }
 207   }
 208
 209   /**
 210    * Return the list of state objects
 211    *
 212    * @return array array of states in the state machine
 213    */
 214   public function getStates() {
 215     return $this->_states;
 216   }
 217
 218   /**
 219    * Return the state object corresponding to the name
 220    *
 221    * @param string $name
 222    *   Name of page.
 223    *
 224    * @return CRM_Core_State state object matching the name
 225    */
 226   public function &getState($name) {
 227     if (isset($this->_states[$name])) {
 228     return $this->_states[$name];
 229   }
 230
 231     /*
 232      * This is a gross hack for ajax driven requests where
 233      * we change the form name to allow multiple edits to happen
 234      * We need a cleaner way of doing this going forward
 235      */
 236     foreach ($this->_states as $n => $s ) {
 237       if (substr($name, 0, strlen($n)) == $n) {
 238         return $s;
 239       }
 240     }
 241
 242     return null;
 243   }
 244
 245   /**
 246    * Return the list of form objects
 247    *
 248    * @return array array of pages in the state machine
 249    */
 250   public function getPages() {
 251     return $this->_pages;
 252   }
 253
 254   /**
 255    * AddSequentialStates: meta level function to create a simple
 256    * wizard for a state machine that is completely sequential.
 257    *
 258    *
 259    * @param array $pages
 260    *   (reference ) the array of page objects.
 261    *
 262    * @internal param array $states states is an array of arrays. Each element
 263    * of the top level array describes a state. Each state description
 264    * includes the name, the display name and the class name
 265    *
 266    * @return void
 267    */
 268   public function addSequentialPages(&$pages) {
 269     $this->_pages = &$pages;
 270     $numPages = count($pages);
 271
 272     $this->_pageNames = array();
 273     foreach ($pages as $tempName => $value) {
 274       if (!empty($value['className'])) {
 275         $this->_pageNames[] = $tempName;
 276       }
 277       else {
 278         $this->_pageNames[] = CRM_Utils_String::getClassName($tempName);
 279       }
 280     }
 281
 282     $i = 0;
 283     foreach ($pages as $tempName => $value) {
 284       $name = $this->_pageNames[$i];
 285
 286       $className = CRM_Utils_Array::value('className',
 287         $value,
 288         $tempName
 289       );
 290       $classPath = str_replace('_', '/', $className) . '.php';
 291       if ($numPages == 1) {
 292         $prev = $next = NULL;
 293         $type = CRM_Core_State::START | CRM_Core_State::FINISH;
 294       }
 295       elseif ($i == 0) {
 296         // start state
 297         $prev = NULL;
 298         $next = $this->_pageNames[$i + 1];
 299         $type = CRM_Core_State::START;
 300       }
 301       elseif ($i == $numPages - 1) {
 302         // finish state
 303         $prev = $this->_pageNames[$i - 1];
 304         $next = NULL;
 305         $type = CRM_Core_State::FINISH;
 306       }
 307       else {
 308         // in between simple state
 309         $prev = $this->_pageNames[$i - 1];
 310         $next = $this->_pageNames[$i + 1];
 311         $type = CRM_Core_State::SIMPLE;
 312       }
 313
 314       $this->addState($name, $type, $prev, $next);
 315
 316       $i++;
 317     }
 318   }
 319
 320   /**
 321    * Reset the state machine
 322    *
 323    * @return void
 324    */
 325   public function reset() {
 326     $this->_controller->reset();
 327   }
 328
 329   /**
 330    * Getter for action
 331    *
 332    * @return int
 333    */
 334   public function getAction() {
 335     return $this->_action;
 336   }
 337
 338   /**
 339    * Setter for content
 340    *
 341    * @param string $content
 342    *   The content generated by this state machine.
 343    *
 344    * @return void
 345    */
 346   public function setContent(&$content) {
 347     $this->_controller->setContent($content);
 348   }
 349
 350   /**
 351    * Getter for content
 352    *
 353    * @return string
 354    */
 355   public function &getContent() {
 356     return $this->_controller->getContent();
 357   }
 358
 359   /**
 360    * @return mixed
 361    */
 362   public function getDestination() {
 363     return $this->_controller->getDestination();
 364   }
 365
 366   /**
 367    * @return mixed
 368    */
 369   public function getSkipRedirection() {
 370     return $this->_controller->getSkipRedirection();
 371   }
 372
 373   /**
 374    * @return mixed
 375    */
 376   public function fini() {
 377     return $this->_controller->fini();
 378   }
 379
 380   /**
 381    * @return mixed
 382    */
 383   public function cancelAction() {
 384     return $this->_controller->cancelAction();
 385   }
 386
 387   /**
 388    * Should the controller reset the session
 389    * In some cases, specifically search we want to remember
 390    * state across various actions and want to go back to the
 391    * beginning from the final state, but retain the same session
 392    * values
 393    *
 394    * @return boolean
 395    */
 396   public function shouldReset() {
 397     return TRUE;
 398 }
 399
 400 }