3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
89 * The controller for this state machine.
91 * @param \const|int $action
93 * @return \CRM_Core_StateMachine
96 public function __construct(&$controller, $action = CRM_Core_Action
::NONE
) {
97 $this->_controller
= &$controller;
98 $this->_action
= $action;
100 $this->_states
= array();
108 public function getName() {
119 public function setName($name) {
120 $this->_name
= $name;
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
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).
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();
141 $pageName = $page->getAttribute('name');
142 $data = &$page->controller
->container();
144 $data['values'][$pageName] = $page->exportValues();
145 $data['valid'][$pageName] = $page->validate();
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');
153 $state = &$this->_states
[$pageName];
155 // dont know how or why we landed here so abort and display
158 return $page->handle('display');
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);
170 $state->handleBackState($page);
175 * Helper function to add a State to the state machine
177 * @param string $name
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.
188 public function addState($name, $type, $prev, $next) {
189 $this->_states
[$name] = new CRM_Core_State($name, $type, $prev, $next, $this);
193 * Given a name find the corresponding state
195 * @param string $name
198 * @return object the state object
200 public function find($name) {
201 if (array_key_exists($name, $this->_states
)) {
202 return $this->_states
[$name];
210 * Return the list of state objects
212 * @return array array of states in the state machine
214 public function getStates() {
215 return $this->_states
;
219 * Return the state object corresponding to the name
221 * @param string $name
224 * @return CRM_Core_State state object matching the name
226 public function &getState($name) {
227 if (isset($this->_states
[$name])) {
228 return $this->_states
[$name];
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
236 foreach ($this->_states
as $n => $s) {
237 if (substr($name, 0, strlen($n)) == $n) {
246 * Return the list of form objects
248 * @return array array of pages in the state machine
250 public function getPages() {
251 return $this->_pages
;
255 * AddSequentialStates: meta level function to create a simple
256 * wizard for a state machine that is completely sequential.
259 * @param array $pages
260 * (reference ) the array of page objects.
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
268 public function addSequentialPages(&$pages) {
269 $this->_pages
= &$pages;
270 $numPages = count($pages);
272 $this->_pageNames
= array();
273 foreach ($pages as $tempName => $value) {
274 if (!empty($value['className'])) {
275 $this->_pageNames
[] = $tempName;
278 $this->_pageNames
[] = CRM_Utils_String
::getClassName($tempName);
283 foreach ($pages as $tempName => $value) {
284 $name = $this->_pageNames
[$i];
286 $className = CRM_Utils_Array
::value('className',
290 $classPath = str_replace('_', '/', $className) . '.php';
291 if ($numPages == 1) {
292 $prev = $next = NULL;
293 $type = CRM_Core_State
::START | CRM_Core_State
::FINISH
;
298 $next = $this->_pageNames
[$i +
1];
299 $type = CRM_Core_State
::START
;
301 elseif ($i == $numPages - 1) {
303 $prev = $this->_pageNames
[$i - 1];
305 $type = CRM_Core_State
::FINISH
;
308 // in between simple state
309 $prev = $this->_pageNames
[$i - 1];
310 $next = $this->_pageNames
[$i +
1];
311 $type = CRM_Core_State
::SIMPLE
;
314 $this->addState($name, $type, $prev, $next);
321 * Reset the state machine
325 public function reset() {
326 $this->_controller
->reset();
334 public function getAction() {
335 return $this->_action
;
341 * @param string $content
342 * The content generated by this state machine.
346 public function setContent(&$content) {
347 $this->_controller
->setContent($content);
355 public function &getContent() {
356 return $this->_controller
->getContent();
362 public function getDestination() {
363 return $this->_controller
->getDestination();
369 public function getSkipRedirection() {
370 return $this->_controller
->getSkipRedirection();
376 public function fini() {
377 return $this->_controller
->fini();
383 public function cancelAction() {
384 return $this->_controller
->cancelAction();
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
396 public function shouldReset() {