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