Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
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 | */ |
33 | class CRM_Member_BAO_Query { | |
34 | ||
bb3a214a | 35 | /** |
0955d6b9 | 36 | * Get available fields. |
37 | * | |
bb3a214a EM |
38 | * @return array |
39 | */ | |
00be9182 | 40 | public static function &getFields() { |
6a488035 TO |
41 | $fields = CRM_Member_BAO_Membership::exportableFields(); |
42 | return $fields; | |
43 | } | |
44 | ||
45 | /** | |
0955d6b9 | 46 | * If membership are involved, add the specific membership fields. |
6a488035 | 47 | * |
0955d6b9 | 48 | * @param CRM_Contact_BAO_Query $query |
6a488035 | 49 | */ |
00be9182 | 50 | public static function select(&$query) { |
6a488035 TO |
51 | // if membership mode add membership id |
52 | if ($query->_mode & CRM_Contact_BAO_Query::MODE_MEMBER || | |
53 | CRM_Contact_BAO_Query::componentPresent($query->_returnProperties, 'membership_') | |
54 | ) { | |
55 | ||
56 | $query->_select['membership_id'] = "civicrm_membership.id as membership_id"; | |
57 | $query->_element['membership_id'] = 1; | |
58 | $query->_tables['civicrm_membership'] = 1; | |
59 | $query->_whereTables['civicrm_membership'] = 1; | |
60 | ||
61 | //add membership type | |
a7488080 | 62 | if (!empty($query->_returnProperties['membership_type'])) { |
6a488035 TO |
63 | $query->_select['membership_type'] = "civicrm_membership_type.name as membership_type"; |
64 | $query->_element['membership_type'] = 1; | |
65 | $query->_tables['civicrm_membership_type'] = 1; | |
66 | $query->_whereTables['civicrm_membership_type'] = 1; | |
67 | } | |
68 | ||
69 | //add join date | |
a7488080 | 70 | if (!empty($query->_returnProperties['join_date'])) { |
6a488035 TO |
71 | $query->_select['join_date'] = "civicrm_membership.join_date as join_date"; |
72 | $query->_element['join_date'] = 1; | |
73 | } | |
74 | ||
75 | //add source | |
a7488080 | 76 | if (!empty($query->_returnProperties['membership_source'])) { |
6a488035 TO |
77 | $query->_select['membership_source'] = "civicrm_membership.source as membership_source"; |
78 | $query->_element['membership_source'] = 1; | |
79 | } | |
80 | ||
81 | //add status | |
a7488080 | 82 | if (!empty($query->_returnProperties['membership_status'])) { |
6a488035 TO |
83 | $query->_select['membership_status'] = "civicrm_membership_status.label as membership_status"; |
84 | $query->_element['membership_status'] = 1; | |
85 | $query->_tables['civicrm_membership_status'] = 1; | |
86 | $query->_whereTables['civicrm_membership_status'] = 1; | |
87 | } | |
88 | ||
994bde4e | 89 | if (!empty($query->_returnProperties['membership_status_id'])) { |
6a488035 TO |
90 | $query->_select['status_id'] = "civicrm_membership_status.id as status_id"; |
91 | $query->_element['status_id'] = 1; | |
92 | $query->_tables['civicrm_membership_status'] = 1; | |
93 | $query->_whereTables['civicrm_membership_status'] = 1; | |
94 | } | |
95 | ||
96 | //add start date / end date | |
a7488080 | 97 | if (!empty($query->_returnProperties['membership_start_date'])) { |
6a488035 TO |
98 | $query->_select['membership_start_date'] = "civicrm_membership.start_date as membership_start_date"; |
99 | $query->_element['membership_start_date'] = 1; | |
100 | } | |
101 | ||
a7488080 | 102 | if (!empty($query->_returnProperties['membership_end_date'])) { |
6a488035 TO |
103 | $query->_select['membership_end_date'] = "civicrm_membership.end_date as membership_end_date"; |
104 | $query->_element['membership_end_date'] = 1; | |
105 | } | |
106 | ||
107 | //add owner_membership_id | |
a7488080 | 108 | if (!empty($query->_returnProperties['owner_membership_id'])) { |
6a488035 TO |
109 | $query->_select['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id"; |
110 | $query->_element['owner_membership_id'] = 1; | |
111 | } | |
112 | //add max_related | |
a7488080 | 113 | if (!empty($query->_returnProperties['max_related'])) { |
6a488035 TO |
114 | $query->_select['max_related'] = "civicrm_membership.max_related as max_related"; |
115 | $query->_element['max_related'] = 1; | |
116 | } | |
117 | //add recur id w/o taking contribution table in join. | |
a7488080 | 118 | if (!empty($query->_returnProperties['membership_recur_id'])) { |
6a488035 TO |
119 | $query->_select['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id"; |
120 | $query->_element['membership_recur_id'] = 1; | |
121 | } | |
122 | ||
123 | //add campaign id. | |
a7488080 | 124 | if (!empty($query->_returnProperties['member_campaign_id'])) { |
6a488035 TO |
125 | $query->_select['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id'; |
126 | $query->_element['member_campaign_id'] = 1; | |
127 | } | |
128 | } | |
129 | } | |
130 | ||
bb3a214a | 131 | /** |
0955d6b9 | 132 | * Generate where clause. |
133 | * | |
134 | * @param CRM_Contact_BAO_Query $query | |
bb3a214a | 135 | */ |
00be9182 | 136 | public static function where(&$query) { |
6a488035 | 137 | foreach (array_keys($query->_params) as $id) { |
a7488080 | 138 | if (empty($query->_params[$id][0])) { |
6a488035 TO |
139 | continue; |
140 | } | |
3c53f77e | 141 | if (substr($query->_params[$id][0], 0, 7) == 'member_' || substr($query->_params[$id][0], 0, 11) == 'membership_') { |
6a488035 TO |
142 | if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) { |
143 | $query->_useDistinct = TRUE; | |
144 | } | |
6a488035 TO |
145 | self::whereClauseSingle($query->_params[$id], $query); |
146 | } | |
147 | } | |
6a488035 TO |
148 | } |
149 | ||
bb3a214a | 150 | /** |
0955d6b9 | 151 | * Generate where for a single parameter. |
152 | * | |
153 | * @param array $values | |
154 | * @param CRM_Contact_BAO_Query $query | |
bb3a214a | 155 | */ |
00be9182 | 156 | public static function whereClauseSingle(&$values, &$query) { |
0955d6b9 | 157 | list($name, $op, $value, $grouping) = $values; |
6a488035 TO |
158 | switch ($name) { |
159 | case 'member_join_date_low': | |
160 | case 'member_join_date_high': | |
161 | $query->dateQueryBuilder($values, | |
162 | 'civicrm_membership', 'member_join_date', 'join_date', | |
163 | 'Member Since' | |
164 | ); | |
165 | return; | |
166 | ||
167 | case 'member_start_date_low': | |
168 | case 'member_start_date_high': | |
169 | $query->dateQueryBuilder($values, | |
170 | 'civicrm_membership', 'member_start_date', 'start_date', | |
171 | 'Start Date' | |
172 | ); | |
173 | return; | |
174 | ||
175 | case 'member_end_date_low': | |
176 | case 'member_end_date_high': | |
177 | $query->dateQueryBuilder($values, | |
178 | 'civicrm_membership', 'member_end_date', 'end_date', | |
179 | 'End Date' | |
180 | ); | |
181 | return; | |
182 | ||
183 | case 'member_join_date': | |
184 | $op = '>='; | |
185 | $date = CRM_Utils_Date::format($value); | |
186 | if ($date) { | |
187 | $query->_where[$grouping][] = "civicrm_membership.join_date {$op} {$date}"; | |
6a488035 TO |
188 | $format = CRM_Utils_Date::customFormat(CRM_Utils_Date::format(array_reverse($value), '-')); |
189 | $query->_qill[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op)); | |
190 | } | |
191 | ||
192 | return; | |
193 | ||
194 | case 'member_source': | |
195 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
196 | $value = $strtolower(CRM_Core_DAO::escapeString(trim($value))); | |
197 | ||
198 | $query->_where[$grouping][] = "civicrm_membership.source $op '{$value}'"; | |
199 | $query->_qill[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op)); | |
200 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
201 | return; | |
202 | ||
a24603f0 | 203 | // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6. |
204 | case 'member_status_id': | |
205 | case 'member_membership_type_id': | |
206 | if (is_array($value)) { | |
1b6dac98 | 207 | $op = 'IN'; |
208 | $value = array_keys($value); | |
a24603f0 | 209 | } |
3c53f77e | 210 | case 'membership_status': |
994bde4e | 211 | case 'membership_status_id': |
0a74debb | 212 | case 'membership_type': |
213 | case 'membership_type_id': | |
214 | case 'member_id': | |
6f56dc34 | 215 | case 'member_campaign_id': |
216 | ||
0a74debb | 217 | if (strpos($name, 'status') !== FALSE) { |
218 | $name = 'status_id'; | |
219 | $qillName = 'Membership Status(s)'; | |
3c53f77e | 220 | } |
0a74debb | 221 | elseif ($name == 'member_id') { |
222 | $name = 'id'; | |
223 | $qillName = 'Membership ID'; | |
6a488035 | 224 | } |
6f56dc34 | 225 | elseif ($name == 'member_campaign_id') { |
226 | $name = 'campaign_id'; | |
227 | $qillName = 'Campaign'; | |
228 | } | |
0a74debb | 229 | else { |
230 | $name = 'membership_type_id'; | |
c3403774 | 231 | $qillName = 'Membership Type(s)'; |
6a488035 | 232 | } |
0a74debb | 233 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.$name", |
6a488035 | 234 | $op, |
0a74debb | 235 | $value, |
6a488035 TO |
236 | "Integer" |
237 | ); | |
0a74debb | 238 | list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op); |
0955d6b9 | 239 | $query->_qill[$grouping][] = ts('%1 %2 %3', array( |
240 | 1 => $qillName, | |
241 | 2 => $op, | |
242 | 3 => $value, | |
243 | )); | |
6a488035 TO |
244 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
245 | return; | |
246 | ||
247 | case 'member_test': | |
28c666be CW |
248 | // We dont want to include all tests for sql OR CRM-7827 |
249 | if (!$value || $query->getOperator() != 'OR') { | |
250 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_test", $op, $value, "Boolean"); | |
251 | if ($value) { | |
252 | $query->_qill[$grouping][] = ts('Membership is a Test'); | |
253 | } | |
6a488035 | 254 | } |
227690c8 | 255 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; |
6a488035 TO |
256 | return; |
257 | ||
258 | case 'member_auto_renew': | |
259 | $op = "!="; | |
260 | if ($value) { | |
261 | $query->_where[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL"; | |
262 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause( | |
263 | "ccr.contribution_status_id", | |
264 | $op, | |
3ac2136c | 265 | array_search( |
b09fe5ed | 266 | 'Cancelled', |
3ac2136c | 267 | CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name') |
6a488035 TO |
268 | ), |
269 | "Integer" | |
270 | ); | |
271 | $query->_qill[$grouping][] = ts("Membership is Auto-Renew"); | |
272 | } | |
273 | else { | |
274 | $query->_where[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL"; | |
275 | $query->_qill[$grouping][] = ts("Membership is NOT Auto-Renew"); | |
276 | } | |
277 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
278 | return; | |
279 | ||
280 | case 'member_pay_later': | |
281 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_pay_later", | |
282 | $op, | |
283 | $value, | |
284 | "Integer" | |
285 | ); | |
286 | if ($value) { | |
287 | $query->_qill[$grouping][] = ts("Membership is Pay Later"); | |
288 | } | |
289 | else { | |
290 | $query->_qill[$grouping][] = ts("Membership is NOT Pay Later"); | |
291 | } | |
292 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
293 | return; | |
294 | ||
6a488035 TO |
295 | case 'member_is_primary': |
296 | if ($value) { | |
297 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NULL"; | |
298 | $query->_qill[$grouping][] = ts("Primary Members Only"); | |
299 | } | |
300 | else { | |
301 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL"; | |
302 | $query->_qill[$grouping][] = ts("Related Members Only"); | |
303 | } | |
304 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
305 | return; | |
6a488035 TO |
306 | } |
307 | } | |
308 | ||
bb3a214a | 309 | /** |
0955d6b9 | 310 | * Generate from clause. |
311 | * | |
100fef9d | 312 | * @param string $name |
0955d6b9 | 313 | * @param int $mode |
314 | * @param string $side | |
bb3a214a | 315 | * |
0955d6b9 | 316 | * @return string |
bb3a214a | 317 | */ |
00be9182 | 318 | public static function from($name, $mode, $side) { |
6a488035 TO |
319 | $from = NULL; |
320 | switch ($name) { | |
321 | case 'civicrm_membership': | |
322 | $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id "; | |
323 | $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )"; | |
324 | break; | |
325 | ||
326 | case 'civicrm_membership_type': | |
327 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
328 | $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
329 | } | |
330 | else { | |
331 | $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
332 | } | |
333 | break; | |
334 | ||
335 | case 'civicrm_membership_status': | |
336 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
337 | $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
338 | } | |
339 | else { | |
340 | $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
341 | } | |
342 | break; | |
343 | ||
344 | case 'civicrm_membership_payment': | |
345 | $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id "; | |
346 | break; | |
347 | } | |
348 | return $from; | |
349 | } | |
350 | ||
bb3a214a | 351 | /** |
0955d6b9 | 352 | * Get default return properties. |
353 | * | |
354 | * @param string $mode | |
bb3a214a EM |
355 | * @param bool $includeCustomFields |
356 | * | |
357 | * @return array|null | |
358 | */ | |
87a890cc | 359 | public static function defaultReturnProperties( |
500cfe81 | 360 | $mode, |
6a488035 TO |
361 | $includeCustomFields = TRUE |
362 | ) { | |
363 | $properties = NULL; | |
364 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
365 | $properties = array( | |
366 | 'contact_type' => 1, | |
367 | 'contact_sub_type' => 1, | |
368 | 'sort_name' => 1, | |
369 | 'display_name' => 1, | |
370 | 'membership_type' => 1, | |
371 | 'member_is_test' => 1, | |
372 | 'member_is_pay_later' => 1, | |
373 | 'join_date' => 1, | |
374 | 'membership_start_date' => 1, | |
375 | 'membership_end_date' => 1, | |
376 | 'membership_source' => 1, | |
377 | 'membership_status' => 1, | |
378 | 'membership_id' => 1, | |
379 | 'owner_membership_id' => 1, | |
380 | 'max_related' => 1, | |
381 | 'membership_recur_id' => 1, | |
382 | 'member_campaign_id' => 1, | |
383 | ); | |
384 | ||
385 | if ($includeCustomFields) { | |
386 | // also get all the custom membership properties | |
387 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Membership'); | |
388 | if (!empty($fields)) { | |
389 | foreach ($fields as $name => $dontCare) { | |
390 | $properties[$name] = 1; | |
391 | } | |
392 | } | |
393 | } | |
394 | } | |
395 | ||
396 | return $properties; | |
397 | } | |
398 | ||
bb3a214a | 399 | /** |
0955d6b9 | 400 | * Build the search form. |
401 | * | |
c490a46a | 402 | * @param CRM_Core_Form $form |
bb3a214a | 403 | */ |
00be9182 | 404 | public static function buildSearchForm(&$form) { |
994bde4e | 405 | $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(); |
0955d6b9 | 406 | $form->add('select', 'membership_status_id', ts('Membership Status(s)'), $membershipStatus, FALSE, array( |
407 | 'id' => 'membership_status_id', | |
408 | 'multiple' => 'multiple', | |
409 | 'class' => 'crm-select2', | |
410 | )); | |
6a488035 TO |
411 | |
412 | $form->addElement('text', 'member_source', ts('Source')); | |
413 | ||
bc3f7f04 | 414 | CRM_Core_Form_Date::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE); |
6a488035 | 415 | |
bc3f7f04 | 416 | CRM_Core_Form_Date::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE); |
6a488035 | 417 | |
bc3f7f04 | 418 | CRM_Core_Form_Date::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE); |
6a488035 | 419 | |
8a4f27dc CW |
420 | $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE); |
421 | $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE); | |
422 | $form->addYesNo('member_auto_renew', ts('Auto-Renew?'), TRUE); | |
423 | $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE); | |
6a488035 TO |
424 | |
425 | // add all the custom searchable fields | |
426 | $extends = array('Membership'); | |
427 | $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); | |
428 | if ($groupDetails) { | |
429 | $form->assign('membershipGroupTree', $groupDetails); | |
430 | foreach ($groupDetails as $group) { | |
431 | foreach ($group['fields'] as $field) { | |
432 | $fieldId = $field['id']; | |
433 | $elementName = 'custom_' . $fieldId; | |
434 | CRM_Core_BAO_CustomField::addQuickFormElement($form, | |
435 | $elementName, | |
436 | $fieldId, | |
437 | FALSE, FALSE, TRUE | |
438 | ); | |
439 | } | |
440 | } | |
441 | } | |
442 | ||
443 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'member_campaign_id'); | |
444 | ||
445 | $form->assign('validCiviMember', TRUE); | |
446 | $form->setDefaults(array('member_test' => 0)); | |
447 | } | |
448 | ||
bb3a214a | 449 | /** |
0955d6b9 | 450 | * Possibly un-required function. |
451 | * | |
452 | * @param array $row | |
100fef9d | 453 | * @param int $id |
bb3a214a | 454 | */ |
b09fe5ed TO |
455 | public static function searchAction(&$row, $id) { |
456 | } | |
6a488035 | 457 | |
bb3a214a | 458 | /** |
0955d6b9 | 459 | * Add membership table. |
460 | * | |
461 | * @param array $tables | |
bb3a214a | 462 | */ |
00be9182 | 463 | public static function tableNames(&$tables) { |
8cc574cf | 464 | if (!empty($tables['civicrm_membership_log']) || !empty($tables['civicrm_membership_status']) || CRM_Utils_Array::value('civicrm_membership_type', $tables)) { |
6a488035 TO |
465 | $tables = array_merge(array('civicrm_membership' => 1), $tables); |
466 | } | |
467 | } | |
96025800 | 468 | |
6a488035 | 469 | } |