| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 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 | * The basic state element. Each state element is linked to a form and |
| 30 | * represents the form in the transition diagram. We use the state to |
| 31 | * determine what action to take on various user input. Actions include |
| 32 | * things like going back / stepping forward / process etc |
| 33 | * |
| 34 | * @package CRM |
| 35 | * @copyright CiviCRM LLC (c) 2004-2019 |
| 36 | */ |
| 37 | class CRM_Core_State { |
| 38 | |
| 39 | /** |
| 40 | * State name. |
| 41 | * @var string |
| 42 | */ |
| 43 | protected $_name; |
| 44 | |
| 45 | /** |
| 46 | * This is a combination "OR" of the STATE_* constants defined below |
| 47 | * @var int |
| 48 | */ |
| 49 | protected $_type; |
| 50 | |
| 51 | /** |
| 52 | * The state that precedes this state. |
| 53 | * @var CRM_Core_State |
| 54 | */ |
| 55 | protected $_back; |
| 56 | |
| 57 | /** |
| 58 | * The state that succeeds this state. |
| 59 | * @var CRM_Core_State |
| 60 | */ |
| 61 | protected $_next; |
| 62 | |
| 63 | /** |
| 64 | * The state machine that this state is part of. |
| 65 | * @var CRM_Core_StateMachine |
| 66 | */ |
| 67 | protected $_stateMachine; |
| 68 | |
| 69 | /** |
| 70 | * The different types of states. As we flush out the framework more |
| 71 | * we will introduce other conditional / looping states which will |
| 72 | * bring in more complexity to the framework. For now, lets keep it simple |
| 73 | * @var int |
| 74 | */ |
| 75 | const START = 1, FINISH = 2, SIMPLE = 4; |
| 76 | |
| 77 | /** |
| 78 | * Constructor. |
| 79 | * |
| 80 | * @param string $name |
| 81 | * Internal name of the state. |
| 82 | * @param int $type |
| 83 | * State type. |
| 84 | * @param CRM_Core_State $back |
| 85 | * State that precedes this state. |
| 86 | * @param CRM_Core_State $next |
| 87 | * State that follows this state. |
| 88 | * @param CRM_Core_StateMachine $stateMachine |
| 89 | * Statemachine that this states belongs to. |
| 90 | * |
| 91 | * @return CRM_Core_State |
| 92 | */ |
| 93 | public function __construct($name, $type, $back, $next, &$stateMachine) { |
| 94 | $this->_name = $name; |
| 95 | $this->_type = $type; |
| 96 | $this->_back = $back; |
| 97 | $this->_next = $next; |
| 98 | |
| 99 | $this->_stateMachine = &$stateMachine; |
| 100 | } |
| 101 | |
| 102 | public function debugPrint() { |
| 103 | CRM_Core_Error::debug("{$this->_name}, {$this->_type}", "{$this->_back}, {$this->_next}"); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Given an CRM Form, jump to the previous page. |
| 108 | * |
| 109 | * @param CRM_Core_Page $page |
| 110 | * |
| 111 | * @return mixed |
| 112 | * does a jump to the back state |
| 113 | */ |
| 114 | public function handleBackState(&$page) { |
| 115 | if ($this->_type & self::START) { |
| 116 | $page->handle('display'); |
| 117 | } |
| 118 | else { |
| 119 | $back = &$page->controller->getPage($this->_back); |
| 120 | return $back->handle('jump'); |
| 121 | } |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Given an CRM Form, jump to the next page. |
| 126 | * |
| 127 | * @param CRM_Core_Page $page |
| 128 | * |
| 129 | * @return mixed |
| 130 | * Does a jump to the nextstate |
| 131 | */ |
| 132 | public function handleNextState(&$page) { |
| 133 | if ($this->_type & self::FINISH) { |
| 134 | $page->handle('process'); |
| 135 | } |
| 136 | else { |
| 137 | $next = &$page->controller->getPage($this->_next); |
| 138 | return $next->handle('jump'); |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Determine the name of the next state. |
| 144 | * |
| 145 | * This is useful when we want to display the navigation labels or potential path. |
| 146 | * |
| 147 | * @return string |
| 148 | */ |
| 149 | public function getNextState() { |
| 150 | if ($this->_type & self::FINISH) { |
| 151 | return NULL; |
| 152 | } |
| 153 | else { |
| 154 | $next = &$page->controller->getPage($this->_next); |
| 155 | return $next; |
| 156 | } |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Mark this page as valid for the QFC framework. |
| 161 | * |
| 162 | * @param array $data |
| 163 | */ |
| 164 | public function validate(&$data) { |
| 165 | $data['valid'][$this->_name] = TRUE; |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Mark this page as invalid for the QFC framework. |
| 170 | * |
| 171 | * @param array $data |
| 172 | */ |
| 173 | public function invalidate(&$data) { |
| 174 | $data['valid'][$this->_name] = NULL; |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Getter for name. |
| 179 | * |
| 180 | * @return string |
| 181 | */ |
| 182 | public function getName() { |
| 183 | return $this->_name; |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * Setter for name. |
| 188 | * |
| 189 | * @param string $name |
| 190 | */ |
| 191 | public function setName($name) { |
| 192 | $this->_name = $name; |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Getter for type. |
| 197 | * |
| 198 | * @return int |
| 199 | */ |
| 200 | public function getType() { |
| 201 | return $this->_type; |
| 202 | } |
| 203 | |
| 204 | } |