Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { | |
36 | ||
37 | /** | |
38 | * The task that the wizard is currently processing | |
39 | * | |
40 | * @var string | |
6a488035 TO |
41 | */ |
42 | protected $_task; | |
43 | ||
44 | /** | |
fe482240 | 45 | * Class constructor. |
0e2e76cf EM |
46 | * |
47 | * @param object $controller | |
48 | * @param \const|int $action | |
95ea96be | 49 | */ |
608e6658 | 50 | public function __construct($controller, $action = CRM_Core_Action::NONE) { |
6a488035 TO |
51 | parent::__construct($controller, $action); |
52 | ||
53 | $this->_pages = array(); | |
54 | if ($action == CRM_Core_Action::ADVANCED) { | |
55 | $this->_pages['CRM_Contact_Form_Search_Advanced'] = NULL; | |
56 | list($task, $result) = $this->taskName($controller, 'Advanced'); | |
57 | } | |
58 | elseif ($action == CRM_Core_Action::PROFILE) { | |
59 | $this->_pages['CRM_Contact_Form_Search_Builder'] = NULL; | |
60 | list($task, $result) = $this->taskName($controller, 'Builder'); | |
61 | } | |
62 | elseif ($action == CRM_Core_Action::COPY) { | |
63 | $this->_pages['CRM_Contact_Form_Search_Custom'] = NULL; | |
64 | list($task, $result) = $this->taskName($controller, 'Custom'); | |
65 | } | |
66 | else { | |
67 | $this->_pages['CRM_Contact_Form_Search_Basic'] = NULL; | |
68 | list($task, $result) = $this->taskName($controller, 'Basic'); | |
69 | } | |
70 | $this->_task = $task; | |
71 | if (is_array($task)) { | |
72 | foreach ($task as $t) { | |
73 | $this->_pages[$t] = NULL; | |
74 | } | |
75 | } | |
76 | else { | |
77 | $this->_pages[$task] = NULL; | |
78 | } | |
79 | ||
80 | if ($result) { | |
81 | $this->_pages['CRM_Contact_Form_Task_Result'] = NULL; | |
82 | } | |
83 | ||
84 | $this->addSequentialPages($this->_pages, $action); | |
85 | } | |
86 | ||
87 | /** | |
88 | * Determine the form name based on the action. This allows us | |
89 | * to avoid using conditional state machine, much more efficient | |
90 | * and simpler | |
91 | * | |
77c5b619 TO |
92 | * @param CRM_Core_Controller $controller |
93 | * The controller object. | |
6a488035 | 94 | * |
77b97be7 EM |
95 | * @param string $formName |
96 | * | |
a6c01b45 CW |
97 | * @return string |
98 | * the name of the form that will handle the task | |
6a488035 | 99 | */ |
00be9182 | 100 | public function taskName($controller, $formName = 'Search') { |
e341bbee | 101 | // total hack, check POST vars and then session to determine stuff |
62c10c94 | 102 | $value = CRM_Utils_Array::value('task', $_POST); |
6a488035 TO |
103 | if (!isset($value)) { |
104 | $value = $this->_controller->get('task'); | |
105 | } | |
106 | $this->_controller->set('task', $value); | |
107 | ||
108 | if ($value) { | |
109 | $componentMode = $this->_controller->get('component_mode'); | |
110 | $modeValue = CRM_Contact_Form_Search::getModeValue($componentMode); | |
0e6e8724 DL |
111 | $taskClassName = $modeValue['taskClassName']; |
112 | return $taskClassName::getTask($value); | |
6a488035 TO |
113 | } |
114 | else { | |
115 | return CRM_Contact_Task::getTask($value); | |
116 | } | |
117 | } | |
118 | ||
119 | /** | |
fe482240 | 120 | * Return the form name of the task. |
6a488035 TO |
121 | * |
122 | * @return string | |
6a488035 | 123 | */ |
00be9182 | 124 | public function getTaskFormName() { |
6a488035 TO |
125 | if (is_array($this->_task)) { |
126 | // return first page | |
127 | return CRM_Utils_String::getClassName($this->_task[0]); | |
128 | } | |
129 | else { | |
130 | return CRM_Utils_String::getClassName($this->_task); | |
131 | } | |
132 | } | |
133 | ||
134 | /** | |
135 | * Since this is a state machine for search and we want to come back to the same state | |
136 | * we dont want to issue a reset of the state session when we are done processing a task | |
6a488035 | 137 | */ |
00be9182 | 138 | public function shouldReset() { |
6a488035 TO |
139 | return FALSE; |
140 | } | |
96025800 | 141 | |
6a488035 | 142 | } |