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