Commit | Line | Data |
---|---|---|
888da08c MW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
888da08c | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
888da08c MW |
9 | +--------------------------------------------------------------------+ |
10 | */ | |
11 | ||
12 | /** | |
13 | * @package CRM | |
ca5cec67 | 14 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
888da08c MW |
15 | */ |
16 | ||
17 | /** | |
18 | * This is a shared parent class for form task actions. | |
19 | */ | |
20 | abstract class CRM_Core_Form_Task extends CRM_Core_Form { | |
21 | ||
22 | /** | |
23 | * The task being performed | |
24 | * | |
25 | * @var int | |
26 | */ | |
27 | protected $_task; | |
28 | ||
29 | /** | |
30 | * The additional clause that we restrict the search with | |
31 | * | |
32 | * @var string | |
33 | */ | |
34 | protected $_componentClause = NULL; | |
35 | ||
36 | /** | |
37 | * The array that holds all the component ids | |
38 | * | |
39 | * @var array | |
40 | */ | |
41 | protected $_componentIds; | |
42 | ||
d5fd18f6 | 43 | /** |
44 | * @var int | |
45 | */ | |
46 | protected $queryMode; | |
47 | ||
888da08c MW |
48 | /** |
49 | * The array that holds all the case ids | |
50 | * | |
51 | * @var array | |
52 | */ | |
53 | public $_entityIds; | |
54 | ||
55 | /** | |
56 | * The array that holds all the contact ids | |
57 | * | |
58 | * @var array | |
59 | */ | |
60 | public $_contactIds; | |
61 | ||
fe841bdf MW |
62 | /** |
63 | * Must be set to entity table name (eg. civicrm_participant) by child class | |
64 | * | |
65 | * @var string | |
66 | */ | |
518fa0ee | 67 | public static $tableName = NULL; |
fe841bdf MW |
68 | |
69 | /** | |
70 | * Must be set to entity shortname (eg. event) | |
71 | * | |
72 | * @var string | |
73 | */ | |
518fa0ee | 74 | public static $entityShortname = NULL; |
888da08c MW |
75 | |
76 | /** | |
77 | * Build all the data structures needed to build the form. | |
6e3090fb MW |
78 | * |
79 | * @throws \CRM_Core_Exception | |
888da08c MW |
80 | */ |
81 | public function preProcess() { | |
6e3090fb MW |
82 | self::preProcessCommon($this); |
83 | } | |
84 | ||
85 | /** | |
86 | * Common pre-processing function. | |
87 | * | |
a0174743 | 88 | * @param CRM_Core_Form_Task $form |
6e3090fb MW |
89 | * |
90 | * @throws \CRM_Core_Exception | |
91 | */ | |
fe841bdf | 92 | public static function preProcessCommon(&$form) { |
be2fb01f | 93 | $form->_entityIds = []; |
888da08c | 94 | |
fe841bdf | 95 | $searchFormValues = $form->controller->exportValues($form->get('searchFormName')); |
888da08c | 96 | |
fe841bdf | 97 | $form->_task = $searchFormValues['task']; |
6e3090fb | 98 | $className = 'CRM_' . ucfirst($form::$entityShortname) . '_Task'; |
888da08c | 99 | $entityTasks = $className::tasks(); |
6e3090fb | 100 | $form->assign('taskName', $entityTasks[$form->_task]); |
888da08c | 101 | |
be2fb01f | 102 | $entityIds = []; |
fe841bdf MW |
103 | if ($searchFormValues['radio_ts'] == 'ts_sel') { |
104 | foreach ($searchFormValues as $name => $value) { | |
888da08c | 105 | if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) { |
fe841bdf | 106 | $entityIds[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN); |
888da08c MW |
107 | } |
108 | } | |
109 | } | |
110 | else { | |
6e3090fb | 111 | $queryParams = $form->get('queryParams'); |
888da08c | 112 | $sortOrder = NULL; |
6e3090fb MW |
113 | if ($form->get(CRM_Utils_Sort::SORT_ORDER)) { |
114 | $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER); | |
888da08c MW |
115 | } |
116 | ||
a0174743 | 117 | $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE, $form->getQueryMode()); |
6e3090fb MW |
118 | $query->_distinctComponentClause = " ( " . $form::$tableName . ".id )"; |
119 | $query->_groupByComponentClause = " GROUP BY " . $form::$tableName . ".id "; | |
888da08c | 120 | $result = $query->searchQuery(0, 0, $sortOrder); |
6e3090fb | 121 | $selector = $form::$entityShortname . '_id'; |
888da08c | 122 | while ($result->fetch()) { |
fe841bdf | 123 | $entityIds[] = $result->$selector; |
888da08c MW |
124 | } |
125 | } | |
126 | ||
fe841bdf MW |
127 | if (!empty($entityIds)) { |
128 | $form->_componentClause = ' ' . $form::$tableName . '.id IN ( ' . implode(',', $entityIds) . ' ) '; | |
129 | $form->assign('totalSelected' . ucfirst($form::$entityShortname) . 's', count($entityIds)); | |
888da08c MW |
130 | } |
131 | ||
fe841bdf | 132 | $form->_entityIds = $form->_componentIds = $entityIds; |
888da08c | 133 | |
39fecc8a MW |
134 | // Some functions (eg. PDF letter tokens) rely on Ids being in specific fields rather than the generic $form->_entityIds |
135 | // So we set that specific field here (eg. for cases $form->_caseIds = $form->_entityIds). | |
136 | // FIXME: This is really to handle legacy code that should probably be updated to use $form->_entityIds | |
137 | $entitySpecificIdsName = '_' . $form::$entityShortname . 'Ids'; | |
138 | $form->$entitySpecificIdsName = $form->_entityIds; | |
139 | ||
888da08c | 140 | //set the context for redirection for any task actions |
6e3090fb | 141 | $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form); |
888da08c MW |
142 | $urlParams = 'force=1'; |
143 | if (CRM_Utils_Rule::qfKey($qfKey)) { | |
144 | $urlParams .= "&qfKey=$qfKey"; | |
145 | } | |
146 | ||
147 | $session = CRM_Core_Session::singleton(); | |
6e3090fb | 148 | $searchFormName = strtolower($form->get('searchFormName')); |
888da08c | 149 | if ($searchFormName == 'search') { |
6e3090fb | 150 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/' . $form::$entityShortname . '/search', $urlParams)); |
888da08c MW |
151 | } |
152 | else { | |
153 | $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName", | |
154 | $urlParams | |
155 | )); | |
156 | } | |
157 | } | |
158 | ||
159 | /** | |
6e3090fb MW |
160 | * Given the entity id, compute the contact id since its used for things like send email |
161 | * For example, for cases we need to override this function as the table name is civicrm_case_contact | |
888da08c MW |
162 | */ |
163 | public function setContactIDs() { | |
9e7fec13 | 164 | $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_entityIds, |
888da08c MW |
165 | $this::$tableName |
166 | ); | |
167 | } | |
168 | ||
169 | /** | |
170 | * Simple shell that derived classes can call to add buttons to | |
171 | * the form with a customized title for the main Submit | |
172 | * | |
173 | * @param string $title | |
174 | * Title of the main button. | |
175 | * @param string $nextType | |
176 | * Button type for the form after processing. | |
177 | * @param string $backType | |
178 | * @param bool $submitOnce | |
179 | */ | |
180 | public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { | |
be2fb01f | 181 | $this->addButtons([ |
518fa0ee SL |
182 | [ |
183 | 'type' => $nextType, | |
184 | 'name' => $title, | |
185 | 'isDefault' => TRUE, | |
186 | ], | |
187 | [ | |
188 | 'type' => $backType, | |
189 | 'name' => ts('Cancel'), | |
190 | ], | |
191 | ]); | |
888da08c MW |
192 | } |
193 | ||
a0174743 MW |
194 | /** |
195 | * Get the query mode (eg. CRM_Core_BAO_Query::MODE_CASE) | |
196 | * Should be overridden by child classes in most cases | |
197 | * | |
198 | * @return int | |
199 | */ | |
200 | public function getQueryMode() { | |
d5fd18f6 | 201 | return $this->queryMode ?: CRM_Contact_BAO_Query::MODE_CONTACTS; |
a0174743 MW |
202 | } |
203 | ||
2e9051c7 D |
204 | /** |
205 | * Given the component id, compute the contact id | |
206 | * since it's used for things like send email. | |
207 | * | |
208 | * @todo At the moment this duplicates a similar function in CRM_Core_DAO | |
209 | * because right now only the case component is using this. Since the | |
210 | * default $orderBy is '' which is what the original does, others should be | |
211 | * easily convertable as NFC. | |
212 | * @todo The passed in variables should be class member variables. Shouldn't | |
213 | * need to have passed in vars. | |
214 | * | |
215 | * @param $componentIDs | |
216 | * @param string $tableName | |
217 | * @param string $idField | |
218 | * | |
219 | * @return array | |
220 | */ | |
221 | public function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') { | |
222 | $contactIDs = []; | |
223 | ||
224 | if (empty($componentIDs)) { | |
225 | return $contactIDs; | |
226 | } | |
227 | ||
228 | $orderBy = $this->orderBy(); | |
229 | ||
230 | $IDs = implode(',', $componentIDs); | |
231 | $query = " | |
232 | SELECT contact_id | |
233 | FROM $tableName | |
234 | WHERE $idField IN ( $IDs ) $orderBy | |
235 | "; | |
236 | ||
237 | $dao = CRM_Core_DAO::executeQuery($query); | |
238 | while ($dao->fetch()) { | |
239 | $contactIDs[] = $dao->contact_id; | |
240 | } | |
241 | return $contactIDs; | |
242 | } | |
243 | ||
244 | /** | |
245 | * Default ordering for getContactIDsFromComponent. Subclasses can override. | |
246 | * | |
247 | * @return string | |
248 | * SQL fragment. Either return '' or a valid order clause including the | |
249 | * words "ORDER BY", e.g. "ORDER BY `{$this->idField}`" | |
250 | */ | |
251 | public function orderBy() { | |
252 | return ''; | |
253 | } | |
254 | ||
888da08c | 255 | } |