3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
90 * @param \const|int $action
92 * @return \CRM_Core_StateMachine
95 function __construct(&$controller, $action = CRM_Core_Action
::NONE
) {
96 $this->_controller
= &$controller;
97 $this->_action
= $action;
99 $this->_states
= array();
108 public function getName() {
120 public function setName($name) {
121 $this->_name
= $name;
125 * Do a state transition jump. Currently only supported types are
126 * Next and Back. The other actions (Cancel, Done, Submit etc) do
127 * not need the state machine to figure out where to go
129 * @param CRM_Core_Form $page the current form-page
130 * @param string $actionName Current action name, as one Action object can serve multiple actions
131 * @param string $type The type of transition being requested (Next or Back)
136 function perform(&$page, $actionName, $type = 'Next') {
137 // save the form values and validation status to the session
138 $page->isFormBuilt() or $page->buildForm();
140 $pageName = $page->getAttribute('name');
141 $data = &$page->controller
->container();
143 $data['values'][$pageName] = $page->exportValues();
144 $data['valid'][$pageName] = $page->validate();
146 // if we are going to the next state
147 // Modal form and page is invalid: don't go further
148 if ($type == 'Next' && !$data['valid'][$pageName]) {
149 return $page->handle('display');
152 $state = &$this->_states
[$pageName];
154 // dont know how or why we landed here so abort and display
157 return $page->handle('display');
160 // the page is valid, process it if we are jumping to the next state
161 if ($type == 'Next') {
162 $page->mainProcess();
163 // we get the state again, since postProcess might have changed it
164 // this bug took me forever to find :) Lobo
165 $state = &$this->_states
[$pageName];
166 $state->handleNextState($page);
169 $state->handleBackState($page);
174 * Helper function to add a State to the state machine
176 * @param string $name the internal name
177 * @param int $type the type of state (START|FINISH|SIMPLE)
178 * @param object $prev the previous page if any
179 * @param object $next the next page if any
184 function addState($name, $type, $prev, $next) {
185 $this->_states
[$name] = new CRM_Core_State($name, $type, $prev, $next, $this);
189 * Given a name find the corresponding state
191 * @param string $name the state name
193 * @return object the state object
196 function find($name) {
197 if (array_key_exists($name, $this->_states
)) {
198 return $this->_states
[$name];
206 * Return the list of state objects
208 * @return array array of states in the state machine
211 function getStates() {
212 return $this->_states
;
216 * Return the state object corresponding to the name
218 * @param string $name name of page
220 * @return CRM_Core_State state object matching the name
223 function &getState($name) {
224 if (isset($this->_states
[$name])) {
225 return $this->_states
[$name];
229 * This is a gross hack for ajax driven requests where
230 * we change the form name to allow multiple edits to happen
231 * We need a cleaner way of doing this going forward
233 foreach ($this->_states
as $n => $s ) {
234 if (substr($name, 0, strlen($n)) == $n) {
243 * Return the list of form objects
245 * @return array array of pages in the state machine
248 function getPages() {
249 return $this->_pages
;
253 * AddSequentialStates: meta level function to create a simple
254 * wizard for a state machine that is completely sequential.
258 * @param array $pages (reference ) the array of page objects
260 * @internal param array $states states is an array of arrays. Each element
261 * of the top level array describes a state. Each state description
262 * includes the name, the display name and the class name
266 function addSequentialPages(&$pages) {
267 $this->_pages
= &$pages;
268 $numPages = count($pages);
270 $this->_pageNames
= array();
271 foreach ($pages as $tempName => $value) {
272 if (!empty($value['className'])) {
273 $this->_pageNames
[] = $tempName;
276 $this->_pageNames
[] = CRM_Utils_String
::getClassName($tempName);
281 foreach ($pages as $tempName => $value) {
282 $name = $this->_pageNames
[$i];
284 $className = CRM_Utils_Array
::value('className',
288 $classPath = str_replace('_', '/', $className) . '.php';
289 if ($numPages == 1) {
290 $prev = $next = NULL;
291 $type = CRM_Core_State
::START | CRM_Core_State
::FINISH
;
296 $next = $this->_pageNames
[$i +
1];
297 $type = CRM_Core_State
::START
;
299 elseif ($i == $numPages - 1) {
301 $prev = $this->_pageNames
[$i - 1];
303 $type = CRM_Core_State
::FINISH
;
306 // in between simple state
307 $prev = $this->_pageNames
[$i - 1];
308 $next = $this->_pageNames
[$i +
1];
309 $type = CRM_Core_State
::SIMPLE
;
312 $this->addState($name, $type, $prev, $next);
319 * Reset the state machine
325 $this->_controller
->reset();
334 function getAction() {
335 return $this->_action
;
341 * @param string $content the content generated by this state machine
346 function setContent(&$content) {
347 $this->_controller
->setContent($content);
356 function &getContent() {
357 return $this->_controller
->getContent();
363 function getDestination() {
364 return $this->_controller
->getDestination();
370 function getSkipRedirection() {
371 return $this->_controller
->getSkipRedirection();
378 return $this->_controller
->fini();
384 function cancelAction() {
385 return $this->_controller
->cancelAction();
389 * Should the controller reset the session
390 * In some cases, specifically search we want to remember
391 * state across various actions and want to go back to the
392 * beginning from the final state, but retain the same session
397 function shouldReset() {