Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 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 | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 | 16 | */ |
86a0d21e | 17 | class CRM_Member_BAO_Query extends CRM_Core_BAO_Query { |
6a488035 | 18 | |
bb3a214a | 19 | /** |
0955d6b9 | 20 | * Get available fields. |
21 | * | |
bb3a214a EM |
22 | * @return array |
23 | */ | |
00be9182 | 24 | public static function &getFields() { |
6a488035 TO |
25 | $fields = CRM_Member_BAO_Membership::exportableFields(); |
26 | return $fields; | |
27 | } | |
28 | ||
29 | /** | |
0955d6b9 | 30 | * If membership are involved, add the specific membership fields. |
6a488035 | 31 | * |
0955d6b9 | 32 | * @param CRM_Contact_BAO_Query $query |
6a488035 | 33 | */ |
00be9182 | 34 | public static function select(&$query) { |
6a488035 TO |
35 | // if membership mode add membership id |
36 | if ($query->_mode & CRM_Contact_BAO_Query::MODE_MEMBER || | |
37 | CRM_Contact_BAO_Query::componentPresent($query->_returnProperties, 'membership_') | |
38 | ) { | |
39 | ||
40 | $query->_select['membership_id'] = "civicrm_membership.id as membership_id"; | |
41 | $query->_element['membership_id'] = 1; | |
42 | $query->_tables['civicrm_membership'] = 1; | |
43 | $query->_whereTables['civicrm_membership'] = 1; | |
44 | ||
45 | //add membership type | |
a7488080 | 46 | if (!empty($query->_returnProperties['membership_type'])) { |
6a488035 TO |
47 | $query->_select['membership_type'] = "civicrm_membership_type.name as membership_type"; |
48 | $query->_element['membership_type'] = 1; | |
49 | $query->_tables['civicrm_membership_type'] = 1; | |
50 | $query->_whereTables['civicrm_membership_type'] = 1; | |
51 | } | |
52 | ||
53 | //add join date | |
09ba1975 SL |
54 | if (!empty($query->_returnProperties['membership_join_date'])) { |
55 | $query->_select['membership_join_date'] = "civicrm_membership.join_date as membership_join_date"; | |
56 | $query->_element['membership_join_date'] = 1; | |
6a488035 TO |
57 | } |
58 | ||
59 | //add source | |
a7488080 | 60 | if (!empty($query->_returnProperties['membership_source'])) { |
6a488035 TO |
61 | $query->_select['membership_source'] = "civicrm_membership.source as membership_source"; |
62 | $query->_element['membership_source'] = 1; | |
63 | } | |
64 | ||
65 | //add status | |
a7488080 | 66 | if (!empty($query->_returnProperties['membership_status'])) { |
6a488035 TO |
67 | $query->_select['membership_status'] = "civicrm_membership_status.label as membership_status"; |
68 | $query->_element['membership_status'] = 1; | |
69 | $query->_tables['civicrm_membership_status'] = 1; | |
70 | $query->_whereTables['civicrm_membership_status'] = 1; | |
71 | } | |
72 | ||
daffb464 FVL |
73 | if (!empty($query->_returnProperties['membership_is_current_member'])) { |
74 | $query->_select['is_current_member'] = "civicrm_membership_status.is_current_member as is_current_member"; | |
75 | $query->_element['is_current_member'] = 1; | |
76 | $query->_tables['civicrm_membership_status'] = 1; | |
77 | $query->_whereTables['civicrm_membership_status'] = 1; | |
78 | } | |
79 | ||
994bde4e | 80 | if (!empty($query->_returnProperties['membership_status_id'])) { |
6a488035 TO |
81 | $query->_select['status_id'] = "civicrm_membership_status.id as status_id"; |
82 | $query->_element['status_id'] = 1; | |
83 | $query->_tables['civicrm_membership_status'] = 1; | |
84 | $query->_whereTables['civicrm_membership_status'] = 1; | |
85 | } | |
86 | ||
87 | //add start date / end date | |
a7488080 | 88 | if (!empty($query->_returnProperties['membership_start_date'])) { |
6a488035 TO |
89 | $query->_select['membership_start_date'] = "civicrm_membership.start_date as membership_start_date"; |
90 | $query->_element['membership_start_date'] = 1; | |
91 | } | |
92 | ||
a7488080 | 93 | if (!empty($query->_returnProperties['membership_end_date'])) { |
6a488035 TO |
94 | $query->_select['membership_end_date'] = "civicrm_membership.end_date as membership_end_date"; |
95 | $query->_element['membership_end_date'] = 1; | |
96 | } | |
97 | ||
98 | //add owner_membership_id | |
a7488080 | 99 | if (!empty($query->_returnProperties['owner_membership_id'])) { |
6a488035 TO |
100 | $query->_select['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id"; |
101 | $query->_element['owner_membership_id'] = 1; | |
102 | } | |
103 | //add max_related | |
a7488080 | 104 | if (!empty($query->_returnProperties['max_related'])) { |
6a488035 TO |
105 | $query->_select['max_related'] = "civicrm_membership.max_related as max_related"; |
106 | $query->_element['max_related'] = 1; | |
107 | } | |
108 | //add recur id w/o taking contribution table in join. | |
a7488080 | 109 | if (!empty($query->_returnProperties['membership_recur_id'])) { |
6a488035 TO |
110 | $query->_select['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id"; |
111 | $query->_element['membership_recur_id'] = 1; | |
112 | } | |
113 | ||
114 | //add campaign id. | |
a7488080 | 115 | if (!empty($query->_returnProperties['member_campaign_id'])) { |
6a488035 TO |
116 | $query->_select['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id'; |
117 | $query->_element['member_campaign_id'] = 1; | |
118 | } | |
119 | } | |
120 | } | |
121 | ||
bb3a214a | 122 | /** |
0955d6b9 | 123 | * Generate where clause. |
124 | * | |
125 | * @param CRM_Contact_BAO_Query $query | |
bb3a214a | 126 | */ |
00be9182 | 127 | public static function where(&$query) { |
6a488035 | 128 | foreach (array_keys($query->_params) as $id) { |
a7488080 | 129 | if (empty($query->_params[$id][0])) { |
6a488035 TO |
130 | continue; |
131 | } | |
3c53f77e | 132 | if (substr($query->_params[$id][0], 0, 7) == 'member_' || substr($query->_params[$id][0], 0, 11) == 'membership_') { |
2da8c6c4 | 133 | if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) { |
6a488035 TO |
134 | $query->_useDistinct = TRUE; |
135 | } | |
6a488035 TO |
136 | self::whereClauseSingle($query->_params[$id], $query); |
137 | } | |
138 | } | |
6a488035 TO |
139 | } |
140 | ||
bb3a214a | 141 | /** |
0955d6b9 | 142 | * Generate where for a single parameter. |
143 | * | |
144 | * @param array $values | |
145 | * @param CRM_Contact_BAO_Query $query | |
bb3a214a | 146 | */ |
00be9182 | 147 | public static function whereClauseSingle(&$values, &$query) { |
5f97e97f SL |
148 | if ($query->buildDateRangeQuery($values)) { |
149 | // @todo - move this to Contact_Query in or near the call to | |
150 | // $this->buildRelativeDateQuery($values); | |
151 | return; | |
152 | } | |
0955d6b9 | 153 | list($name, $op, $value, $grouping) = $values; |
f1a47a1c JP |
154 | $fields = self::getFields(); |
155 | ||
c12606e5 SL |
156 | $quoteValue = NULL; |
157 | ||
158 | if (!empty($value) && !is_array($value)) { | |
159 | $quoteValue = "\"$value\""; | |
160 | } | |
161 | ||
162 | $fieldAliases = self::getLegacySupportedFields(); | |
163 | ||
164 | $fieldName = $name = self::getFieldName($values); | |
165 | $qillName = $name; | |
166 | if (in_array($name, $fieldAliases)) { | |
167 | $qillName = array_search($name, $fieldAliases); | |
168 | } | |
169 | $pseudoExtraParam = []; | |
170 | $fieldSpec = CRM_Utils_Array::value($fieldName, $fields, []); | |
171 | $tableName = CRM_Utils_Array::value('table_name', $fieldSpec, 'civicrm_membership'); | |
172 | $dataType = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $fieldSpec)); | |
173 | if ($dataType === 'Timestamp' || $dataType === 'Date') { | |
174 | $title = empty($fieldSpec['unique_title']) ? $fieldSpec['title'] : $fieldSpec['unique_title']; | |
175 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
176 | $query->dateQueryBuilder($values, | |
177 | $tableName, $fieldName, $fieldSpec['name'], $title | |
178 | ); | |
179 | return; | |
180 | } | |
181 | ||
6a488035 TO |
182 | switch ($name) { |
183 | case 'member_join_date_low': | |
184 | case 'member_join_date_high': | |
5f97e97f SL |
185 | Civi::log()->warning( |
186 | 'member_join_date field is deprecated please use membership_join_date field instead', | |
187 | ['civi.tag' => 'deprecated'] | |
188 | ); | |
189 | $fldName = str_replace(['_low', '_high'], '', $name); | |
6a488035 | 190 | $query->dateQueryBuilder($values, |
5f97e97f | 191 | 'civicrm_membership', $fldName, 'join_date', |
6a488035 TO |
192 | 'Member Since' |
193 | ); | |
194 | return; | |
195 | ||
196 | case 'member_start_date_low': | |
197 | case 'member_start_date_high': | |
5f97e97f SL |
198 | Civi::log()->warning( |
199 | 'member_start_date field is deprecated please use membership_start_date field instead', | |
200 | ['civi.tag' => 'deprecated'] | |
201 | ); | |
be2fb01f | 202 | $fldName = str_replace(['_low', '_high'], '', $name); |
6a488035 | 203 | $query->dateQueryBuilder($values, |
6c5a6210 | 204 | 'civicrm_membership', $fldName, 'start_date', |
6a488035 TO |
205 | 'Start Date' |
206 | ); | |
207 | return; | |
208 | ||
209 | case 'member_end_date_low': | |
210 | case 'member_end_date_high': | |
5f97e97f SL |
211 | Civi::log()->warning( |
212 | 'member_end_date field is deprecated please use membership_end_date field instead', | |
213 | ['civi.tag' => 'deprecated'] | |
214 | ); | |
be2fb01f | 215 | $fldName = str_replace(['_low', '_high'], '', $name); |
6a488035 | 216 | $query->dateQueryBuilder($values, |
6c5a6210 | 217 | 'civicrm_membership', $fldName, 'end_date', |
6a488035 TO |
218 | 'End Date' |
219 | ); | |
220 | return; | |
221 | ||
222 | case 'member_join_date': | |
223 | $op = '>='; | |
224 | $date = CRM_Utils_Date::format($value); | |
225 | if ($date) { | |
226 | $query->_where[$grouping][] = "civicrm_membership.join_date {$op} {$date}"; | |
6a488035 | 227 | $format = CRM_Utils_Date::customFormat(CRM_Utils_Date::format(array_reverse($value), '-')); |
be2fb01f | 228 | $query->_qill[$grouping][] = ts('Member Since %2 %1', [1 => $format, 2 => $op]); |
6a488035 TO |
229 | } |
230 | ||
231 | return; | |
232 | ||
233 | case 'member_source': | |
79b6a947 | 234 | case 'membership_source': |
f1a47a1c JP |
235 | $fieldSpec = $fields['membership_source'] ?? []; |
236 | $query->handleWhereFromMetadata($fieldSpec, $name, $value, $op); | |
6a488035 TO |
237 | return; |
238 | ||
a24603f0 | 239 | // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6. |
240 | case 'member_status_id': | |
241 | case 'member_membership_type_id': | |
242 | if (is_array($value)) { | |
1b6dac98 | 243 | $op = 'IN'; |
244 | $value = array_keys($value); | |
a24603f0 | 245 | } |
3c53f77e | 246 | case 'membership_status': |
994bde4e | 247 | case 'membership_status_id': |
0a74debb | 248 | case 'membership_type': |
249 | case 'membership_type_id': | |
beccb90f | 250 | // CRM-17075 we are specifically handling the possibility we are dealing with the entity reference field |
251 | // for membership_type_id here (although status would be handled if converted). The unhandled pathway at the moment | |
252 | // is from groupContactCache::load and this is a small fix to get the entity reference field to work. | |
253 | // However, it would seem the larger fix would be to NOT invoke the form formValues for | |
254 | // the load function. The where clause and the whereTables are saved so they should suffice to generate the query | |
255 | // to get a contact list. But, better to deal with in 4.8 now... | |
256 | if (is_string($value) && strpos($value, ',') && $op == '=') { | |
be2fb01f | 257 | $value = ['IN' => explode(',', $value)]; |
beccb90f | 258 | } |
82a51e0a | 259 | case 'membership_id': |
971e129b SL |
260 | // CRM-18523 Updated to membership_id but kept member_id case for backwards compatibility |
261 | case 'member_id': | |
6f56dc34 | 262 | case 'member_campaign_id': |
263 | ||
0a74debb | 264 | if (strpos($name, 'status') !== FALSE) { |
265 | $name = 'status_id'; | |
34441ede | 266 | $qillName = ts('Membership Status'); |
3c53f77e | 267 | } |
5caf1119 | 268 | elseif ($name == 'membership_id' || $name == 'member_id') { |
0a74debb | 269 | $name = 'id'; |
34441ede | 270 | $qillName = ts('Membership ID'); |
6a488035 | 271 | } |
6f56dc34 | 272 | elseif ($name == 'member_campaign_id') { |
273 | $name = 'campaign_id'; | |
34441ede | 274 | $qillName = ts('Campaign'); |
6f56dc34 | 275 | } |
0a74debb | 276 | else { |
277 | $name = 'membership_type_id'; | |
34441ede | 278 | $qillName = ts('Membership Type'); |
6a488035 | 279 | } |
0a74debb | 280 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.$name", |
6a488035 | 281 | $op, |
0a74debb | 282 | $value, |
6a488035 TO |
283 | "Integer" |
284 | ); | |
0a74debb | 285 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op); |
34441ede | 286 | $query->_qill[$grouping][] = $qillName . ' ' . $op . ' ' . $value; |
6a488035 TO |
287 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
288 | return; | |
289 | ||
daffb464 FVL |
290 | case 'membership_is_current_member': |
291 | // We don't want to include all tests for sql OR CRM-7827 | |
292 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership_status.is_current_member", $op, $value, "Boolean"); | |
d86f3771 | 293 | $query->_qill[$grouping][] = $value ? ts('Is a current member') : ts('Is a non-current member'); |
daffb464 FVL |
294 | $query->_tables['civicrm_membership_status'] = $query->_whereTables['civicrm_membership_status'] = 1; |
295 | return; | |
296 | ||
6a488035 | 297 | case 'member_test': |
19780fb8 | 298 | // We don't want to include all tests for sql OR CRM-7827 |
28c666be CW |
299 | if (!$value || $query->getOperator() != 'OR') { |
300 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_test", $op, $value, "Boolean"); | |
301 | if ($value) { | |
302 | $query->_qill[$grouping][] = ts('Membership is a Test'); | |
303 | } | |
6a488035 | 304 | } |
227690c8 | 305 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
6a488035 TO |
306 | return; |
307 | ||
308 | case 'member_auto_renew': | |
2504db84 | 309 | $op = '='; |
be2fb01f | 310 | $where = $qill = []; |
2504db84 | 311 | foreach ($value as $val) { |
312 | if ($val == 1) { | |
313 | $where[] = ' civicrm_membership.contribution_recur_id IS NULL'; | |
314 | $qill[] = ts('Membership is NOT Auto-Renew'); | |
315 | } | |
316 | elseif ($val == 2) { | |
317 | $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . CRM_Contact_BAO_Query::buildClause( | |
318 | 'ccr.contribution_status_id', | |
319 | $op, | |
320 | array_search( | |
321 | 'In Progress', | |
322 | CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name') | |
323 | ), | |
324 | 'Integer' | |
325 | ); | |
326 | $qill[] = ts('Membership is Auto-Renew and In Progress'); | |
327 | } | |
328 | elseif ($val == 3) { | |
329 | $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . | |
330 | CRM_Contact_BAO_Query::buildClause( | |
331 | 'ccr.contribution_status_id', | |
332 | $op, | |
333 | array_search( | |
334 | 'Failed', | |
335 | CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name') | |
336 | ), | |
337 | 'Integer' | |
338 | ); | |
339 | $qill[] = ts('Membership is Auto-Renew and Failed'); | |
340 | } | |
341 | elseif ($val == 4) { | |
342 | $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . | |
343 | CRM_Contact_BAO_Query::buildClause( | |
344 | 'ccr.contribution_status_id', | |
345 | $op, | |
346 | array_search( | |
347 | 'Cancelled', | |
348 | CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name') | |
349 | ), | |
350 | 'Integer' | |
351 | ); | |
352 | $qill[] = ts('Membership is Auto-Renew and Cancelled'); | |
353 | } | |
354 | elseif ($val == 5) { | |
355 | $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ccr.end_date IS NOT NULL AND ccr.end_date < NOW()'; | |
356 | $qill[] = ts('Membership is Auto-Renew and Ended'); | |
357 | } | |
358 | elseif ($val == 6) { | |
359 | $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL'; | |
360 | $qill[] = ts('Membership is Auto-Renew'); | |
361 | } | |
19780fb8 | 362 | } |
2504db84 | 363 | if (!empty($where)) { |
364 | $query->_where[$grouping][] = implode(' OR ', $where); | |
365 | $query->_qill[$grouping][] = implode(' OR ', $qill); | |
6a488035 | 366 | } |
2504db84 | 367 | |
6a488035 TO |
368 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
369 | return; | |
370 | ||
371 | case 'member_pay_later': | |
372 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_pay_later", | |
373 | $op, | |
374 | $value, | |
375 | "Integer" | |
376 | ); | |
377 | if ($value) { | |
378 | $query->_qill[$grouping][] = ts("Membership is Pay Later"); | |
379 | } | |
380 | else { | |
381 | $query->_qill[$grouping][] = ts("Membership is NOT Pay Later"); | |
382 | } | |
383 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
384 | return; | |
385 | ||
6a488035 TO |
386 | case 'member_is_primary': |
387 | if ($value) { | |
388 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NULL"; | |
389 | $query->_qill[$grouping][] = ts("Primary Members Only"); | |
390 | } | |
391 | else { | |
392 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL"; | |
393 | $query->_qill[$grouping][] = ts("Related Members Only"); | |
394 | } | |
395 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
396 | return; | |
07e1389d SL |
397 | |
398 | case 'member_is_override': | |
399 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_override", $op, $value, "Boolean"); | |
8dcd31bf | 400 | $query->_qill[$grouping][] = $value ? ts("Membership Status Is Overriden") : ts("Membership Status Is NOT Overriden"); |
07e1389d SL |
401 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
402 | return; | |
5f97e97f | 403 | |
6a488035 TO |
404 | } |
405 | } | |
406 | ||
bb3a214a | 407 | /** |
0955d6b9 | 408 | * Generate from clause. |
409 | * | |
100fef9d | 410 | * @param string $name |
0955d6b9 | 411 | * @param int $mode |
412 | * @param string $side | |
bb3a214a | 413 | * |
0955d6b9 | 414 | * @return string |
bb3a214a | 415 | */ |
00be9182 | 416 | public static function from($name, $mode, $side) { |
6a488035 TO |
417 | $from = NULL; |
418 | switch ($name) { | |
419 | case 'civicrm_membership': | |
420 | $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id "; | |
421 | $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )"; | |
422 | break; | |
423 | ||
424 | case 'civicrm_membership_type': | |
425 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
426 | $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
427 | } | |
428 | else { | |
429 | $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
430 | } | |
431 | break; | |
432 | ||
433 | case 'civicrm_membership_status': | |
434 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
435 | $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
436 | } | |
437 | else { | |
438 | $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
439 | } | |
440 | break; | |
441 | ||
442 | case 'civicrm_membership_payment': | |
443 | $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id "; | |
444 | break; | |
445 | } | |
446 | return $from; | |
447 | } | |
448 | ||
bb3a214a | 449 | /** |
0955d6b9 | 450 | * Get default return properties. |
451 | * | |
452 | * @param string $mode | |
bb3a214a EM |
453 | * @param bool $includeCustomFields |
454 | * | |
455 | * @return array|null | |
456 | */ | |
87a890cc | 457 | public static function defaultReturnProperties( |
500cfe81 | 458 | $mode, |
6a488035 TO |
459 | $includeCustomFields = TRUE |
460 | ) { | |
461 | $properties = NULL; | |
462 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
be2fb01f | 463 | $properties = [ |
6a488035 TO |
464 | 'contact_type' => 1, |
465 | 'contact_sub_type' => 1, | |
466 | 'sort_name' => 1, | |
467 | 'display_name' => 1, | |
468 | 'membership_type' => 1, | |
469 | 'member_is_test' => 1, | |
470 | 'member_is_pay_later' => 1, | |
09ba1975 | 471 | 'membership_join_date' => 1, |
6a488035 TO |
472 | 'membership_start_date' => 1, |
473 | 'membership_end_date' => 1, | |
474 | 'membership_source' => 1, | |
475 | 'membership_status' => 1, | |
476 | 'membership_id' => 1, | |
477 | 'owner_membership_id' => 1, | |
478 | 'max_related' => 1, | |
479 | 'membership_recur_id' => 1, | |
480 | 'member_campaign_id' => 1, | |
07e1389d | 481 | 'member_is_override' => 1, |
be2fb01f | 482 | ]; |
6a488035 TO |
483 | |
484 | if ($includeCustomFields) { | |
485 | // also get all the custom membership properties | |
486 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Membership'); | |
487 | if (!empty($fields)) { | |
488 | foreach ($fields as $name => $dontCare) { | |
489 | $properties[$name] = 1; | |
490 | } | |
491 | } | |
492 | } | |
493 | } | |
494 | ||
495 | return $properties; | |
496 | } | |
497 | ||
5f97e97f SL |
498 | /** |
499 | * Get the metadata for fields to be included on the grant search form. | |
500 | * | |
501 | * @throws \CiviCRM_API3_Exception | |
502 | */ | |
503 | public static function getSearchFieldMetadata() { | |
504 | $fields = [ | |
505 | 'membership_join_date', | |
506 | 'membership_start_date', | |
507 | 'membership_end_date', | |
03ee227b | 508 | 'membership_type_id', |
f243df22 | 509 | 'membership_status_id', |
5f97e97f SL |
510 | ]; |
511 | $metadata = civicrm_api3('Membership', 'getfields', [])['values']; | |
f243df22 | 512 | // We should really have a unique name in the url but to reduce risk of regression just hacking |
513 | // here for now, since this is being done as an rc fix & the other is moderately risky. | |
514 | // https://lab.civicrm.org/dev/user-interface/-/issues/14 | |
515 | $metadata['membership_status_id'] = $metadata['status_id']; | |
516 | // It can't be autoadded due to ^^. | |
517 | $metadata['membership_status_id']['is_pseudofield'] = TRUE; | |
518 | unset($metadata['status_id']); | |
5f97e97f SL |
519 | return array_intersect_key($metadata, array_flip($fields)); |
520 | } | |
521 | ||
bb3a214a | 522 | /** |
0955d6b9 | 523 | * Build the search form. |
524 | * | |
c490a46a | 525 | * @param CRM_Core_Form $form |
03ee227b | 526 | * |
527 | * @throws \CiviCRM_API3_Exception | |
bb3a214a | 528 | */ |
00be9182 | 529 | public static function buildSearchForm(&$form) { |
5f97e97f SL |
530 | $form->addSearchFieldMetadata(['Membership' => self::getSearchFieldMetadata()]); |
531 | $form->addFormFieldsFromMetadata(); | |
9d4d481e | 532 | $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label', FALSE, FALSE); |
be2fb01f | 533 | $form->add('select', 'membership_status_id', ts('Membership Status'), $membershipStatus, FALSE, [ |
0955d6b9 | 534 | 'id' => 'membership_status_id', |
535 | 'multiple' => 'multiple', | |
536 | 'class' => 'crm-select2', | |
be2fb01f | 537 | ]); |
6a488035 TO |
538 | |
539 | $form->addElement('text', 'member_source', ts('Source')); | |
be2fb01f | 540 | $form->add('number', 'membership_id', ts('Membership ID'), ['class' => 'four', 'min' => 1]); |
6a488035 | 541 | |
d86f3771 | 542 | $form->addYesNo('membership_is_current_member', ts('Current Member?'), TRUE); |
8a4f27dc CW |
543 | $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE); |
544 | $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE); | |
1dc429d1 EH |
545 | |
546 | $form->add('select', 'member_auto_renew', | |
547 | ts('Auto-Renew Subscription Status?'), | |
be2fb01f | 548 | [ |
1dc429d1 EH |
549 | '1' => ts('- None -'), |
550 | '2' => ts('In Progress'), | |
551 | '3' => ts('Failed'), | |
552 | '4' => ts('Cancelled'), | |
553 | '5' => ts('Ended'), | |
2504db84 | 554 | '6' => ts('Any'), |
be2fb01f CW |
555 | ], |
556 | FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')] | |
1dc429d1 EH |
557 | ); |
558 | ||
8a4f27dc | 559 | $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE); |
8dcd31bf | 560 | $form->addYesNo('member_is_override', ts('Membership Status Is Overriden?'), TRUE); |
6a488035 | 561 | |
be2fb01f | 562 | self::addCustomFormFields($form, ['Membership']); |
6a488035 TO |
563 | |
564 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'member_campaign_id'); | |
565 | ||
566 | $form->assign('validCiviMember', TRUE); | |
be2fb01f | 567 | $form->setDefaults(['member_test' => 0]); |
6a488035 TO |
568 | } |
569 | ||
bb3a214a | 570 | /** |
0955d6b9 | 571 | * Add membership table. |
572 | * | |
573 | * @param array $tables | |
bb3a214a | 574 | */ |
00be9182 | 575 | public static function tableNames(&$tables) { |
b99f3e96 | 576 | if (!empty($tables['civicrm_membership_log']) || !empty($tables['civicrm_membership_status']) || !empty($tables['civicrm_membership_type'])) { |
be2fb01f | 577 | $tables = array_merge(['civicrm_membership' => 1], $tables); |
6a488035 TO |
578 | } |
579 | } | |
96025800 | 580 | |
6a488035 | 581 | } |