3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * Core StateMachine. All statemachines subclass for the core one
38 * for functionality specific to their needs.
40 * A statemachine keeps track of differnt states and forms for a
41 * html quickform controller.
44 class CRM_Core_StateMachine
{
47 * the controller of this state machine
50 protected $_controller;
53 * the list of states that belong to this state machine
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
67 * The names of the pages
71 protected $_pageNames;
74 * the mode that the state machine is operating in
77 protected $_action = NULL;
80 * The display name for this machine
83 protected $_name = NULL;
88 * @param object $controller the controller for this state machine
93 function __construct(&$controller, $action = CRM_Core_Action
::NONE
) {
94 $this->_controller
= &$controller;
95 $this->_action
= $action;
97 $this->_states
= array();
106 public function getName() {
118 public function setName($name) {
119 $this->_name
= $name;
123 * do a state transition jump. Currently only supported types are
124 * Next and Back. The other actions (Cancel, Done, Submit etc) do
125 * not need the state machine to figure out where to go
127 * @param object $page CRM_Core_Form the current form-page
128 * @param string $actionName Current action name, as one Action object can serve multiple actions
129 * @param string $type The type of transition being requested (Next or Back)
134 function perform(&$page, $actionName, $type = 'Next') {
135 // save the form values and validation status to the session
136 $page->isFormBuilt() or $page->buildForm();
138 $pageName = $page->getAttribute('name');
139 $data = &$page->controller
->container();
141 $data['values'][$pageName] = $page->exportValues();
142 $data['valid'][$pageName] = $page->validate();
144 // if we are going to the next state
145 // Modal form and page is invalid: don't go further
146 if ($type == 'Next' && !$data['valid'][$pageName]) {
147 return $page->handle('display');
150 $state = &$this->_states
[$pageName];
152 // dont know how or why we landed here so abort and display
155 return $page->handle('display');
158 // the page is valid, process it if we are jumping to the next state
159 if ($type == 'Next') {
160 $page->mainProcess();
161 // we get the state again, since postProcess might have changed it
162 // this bug took me forever to find :) Lobo
163 $state = &$this->_states
[$pageName];
164 $state->handleNextState($page);
167 $state->handleBackState($page);
172 * helper function to add a State to the state machine
174 * @param string $name the internal name
175 * @param int $type the type of state (START|FINISH|SIMPLE)
176 * @param object $prev the previous page if any
177 * @param object $next the next page if any
182 function addState($name, $type, $prev, $next) {
183 $this->_states
[$name] = new CRM_Core_State($name, $type, $prev, $next, $this);
187 * Given a name find the corresponding state
189 * @param string $name the state name
191 * @return object the state object
194 function find($name) {
195 if (array_key_exists($name, $this->_states
)) {
196 return $this->_states
[$name];
204 * return the list of state objects
206 * @return array array of states in the state machine
209 function getStates() {
210 return $this->_states
;
214 * return the state object corresponding to the name
216 * @param string $name name of page
218 * @return CRM_Core_State state object matching the name
221 function &getState($name) {
222 if (isset($this->_states
[$name])) {
223 return $this->_states
[$name];
227 * This is a gross hack for ajax driven requests where
228 * we change the form name to allow multiple edits to happen
229 * We need a cleaner way of doing this going forward
231 foreach ($this->_states
as $n => $s ) {
232 if (substr($name, 0, strlen($n)) == $n) {
241 * return the list of form objects
243 * @return array array of pages in the state machine
246 function getPages() {
247 return $this->_pages
;
251 * addSequentialStates: meta level function to create a simple
252 * wizard for a state machine that is completely sequential.
256 * @param array $states states is an array of arrays. Each element
257 * of the top level array describes a state. Each state description
258 * includes the name, the display name and the class name
260 * @param array $pages (reference ) the array of page objects
264 function addSequentialPages(&$pages) {
265 $this->_pages
= &$pages;
266 $numPages = count($pages);
268 $this->_pageNames
= array();
269 foreach ($pages as $tempName => $value) {
270 if (CRM_Utils_Array
::value('className', $value)) {
271 $this->_pageNames
[] = $tempName;
274 $this->_pageNames
[] = CRM_Utils_String
::getClassName($tempName);
279 foreach ($pages as $tempName => $value) {
280 $name = $this->_pageNames
[$i];
282 $className = CRM_Utils_Array
::value('className',
286 $classPath = str_replace('_', '/', $className) . '.php';
287 if ($numPages == 1) {
288 $prev = $next = NULL;
289 $type = CRM_Core_State
::START | CRM_Core_State
::FINISH
;
294 $next = $this->_pageNames
[$i +
1];
295 $type = CRM_Core_State
::START
;
297 elseif ($i == $numPages - 1) {
299 $prev = $this->_pageNames
[$i - 1];
301 $type = CRM_Core_State
::FINISH
;
304 // in between simple state
305 $prev = $this->_pageNames
[$i - 1];
306 $next = $this->_pageNames
[$i +
1];
307 $type = CRM_Core_State
::SIMPLE
;
310 $this->addState($name, $type, $prev, $next);
317 * reset the state machine
323 $this->_controller
->reset();
332 function getAction() {
333 return $this->_action
;
339 * @param string $content the content generated by this state machine
344 function setContent(&$content) {
345 $this->_controller
->setContent($content);
354 function &getContent() {
355 return $this->_controller
->getContent();
358 function getDestination() {
359 return $this->_controller
->getDestination();
362 function getSkipRedirection() {
363 return $this->_controller
->getSkipRedirection();
367 return $this->_controller
->fini();
370 function cancelAction() {
371 return $this->_controller
->cancelAction();
375 * Should the controller reset the session
376 * In some cases, specifically search we want to remember
377 * state across various actions and want to go back to the
378 * beginning from the final state, but retain the same session
383 function shouldReset() {