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