Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | | |
c73475ea | 12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
6a488035 TO |
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 | | |
c73475ea WA |
20 | | License and the CiviCRM Licensing Exception along | |
21 | | with this program; if not, contact CiviCRM LLC | | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { | |
34 | ||
35 | /** | |
fe482240 | 36 | * The task that the wizard is currently processing. |
6a488035 TO |
37 | * |
38 | * @var string | |
6a488035 TO |
39 | */ |
40 | protected $_task; | |
41 | ||
42 | /** | |
2e2605fe EM |
43 | * Class constructor. |
44 | * | |
645ee340 | 45 | * @param object $controller |
2e2605fe | 46 | * @param \const|int $action |
6a488035 | 47 | */ |
00be9182 | 48 | public function __construct($controller, $action = CRM_Core_Action::NONE) { |
6a488035 TO |
49 | parent::__construct($controller, $action); |
50 | ||
51 | $this->_pages = array(); | |
52 | ||
53 | $this->_pages['CRM_Activity_Form_Search'] = NULL; | |
54 | list($task, $result) = $this->taskName($controller, 'Search'); | |
55 | $this->_task = $task; | |
56 | ||
57 | if (is_array($task)) { | |
58 | foreach ($task as $t) { | |
59 | $this->_pages[$t] = NULL; | |
60 | } | |
61 | } | |
62 | else { | |
63 | $this->_pages[$task] = NULL; | |
64 | } | |
65 | ||
66 | $this->addSequentialPages($this->_pages, $action); | |
67 | } | |
68 | ||
69 | /** | |
70 | * Determine the form name based on the action. This allows us | |
71 | * to avoid using conditional state machine, much more efficient | |
72 | * and simpler | |
73 | * | |
041ab3d1 TO |
74 | * @param CRM_Core_Controller $controller |
75 | * The controller object. | |
6a488035 | 76 | * |
6c8f6e67 EM |
77 | * @param string $formName |
78 | * | |
a6c01b45 CW |
79 | * @return string |
80 | * the name of the form that will handle the task | |
6a488035 | 81 | */ |
00be9182 | 82 | public function taskName($controller, $formName = 'Search') { |
6a488035 | 83 | // total hack, check POST vars and then session to determine stuff |
e341bbee | 84 | $value = CRM_Utils_Array::value('task', $_POST); |
6a488035 TO |
85 | if (!isset($value)) { |
86 | $value = $this->_controller->get('task'); | |
87 | } | |
88 | $this->_controller->set('task', $value); | |
89 | return CRM_Activity_Task::getTask($value); | |
90 | } | |
91 | ||
92 | /** | |
fe482240 | 93 | * Return the form name of the task. |
6a488035 TO |
94 | * |
95 | * @return string | |
6a488035 | 96 | */ |
00be9182 | 97 | public function getTaskFormName() { |
6a488035 TO |
98 | return CRM_Utils_String::getClassName($this->_task); |
99 | } | |
100 | ||
ffd93213 | 101 | /** |
fe482240 | 102 | * Should the controller reset the session. |
ffd93213 EM |
103 | * In some cases, specifically search we want to remember |
104 | * state across various actions and want to go back to the | |
105 | * beginning from the final state, but retain the same session | |
106 | * values | |
107 | * | |
ffd93213 EM |
108 | * @return bool |
109 | */ | |
00be9182 | 110 | public function shouldReset() { |
6a488035 TO |
111 | return FALSE; |
112 | } | |
96025800 | 113 | |
6a488035 | 114 | } |