Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Member_BAO_Query { | |
36 | ||
37 | static function &getFields() { | |
38 | $fields = CRM_Member_BAO_Membership::exportableFields(); | |
39 | return $fields; | |
40 | } | |
41 | ||
42 | /** | |
43 | * if membership are involved, add the specific membership fields | |
44 | * | |
45 | * @return void | |
46 | * @access public | |
47 | */ | |
48 | static function select(&$query) { | |
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 | |
60 | if (CRM_Utils_Array::value('membership_type', $query->_returnProperties)) { | |
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 | |
68 | if (CRM_Utils_Array::value('join_date', $query->_returnProperties)) { | |
69 | $query->_select['join_date'] = "civicrm_membership.join_date as join_date"; | |
70 | $query->_element['join_date'] = 1; | |
71 | } | |
72 | ||
73 | //add source | |
74 | if (CRM_Utils_Array::value('membership_source', $query->_returnProperties)) { | |
75 | $query->_select['membership_source'] = "civicrm_membership.source as membership_source"; | |
76 | $query->_element['membership_source'] = 1; | |
77 | } | |
78 | ||
79 | //add status | |
80 | if (CRM_Utils_Array::value('membership_status', $query->_returnProperties)) { | |
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 | ||
87 | if (CRM_Utils_Array::value('status_id', $query->_returnProperties)) { | |
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 | |
95 | if (CRM_Utils_Array::value('membership_start_date', $query->_returnProperties)) { | |
96 | $query->_select['membership_start_date'] = "civicrm_membership.start_date as membership_start_date"; | |
97 | $query->_element['membership_start_date'] = 1; | |
98 | } | |
99 | ||
100 | if (CRM_Utils_Array::value('membership_end_date', $query->_returnProperties)) { | |
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 | |
106 | if (CRM_Utils_Array::value('owner_membership_id', $query->_returnProperties)) { | |
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 | |
111 | if (CRM_Utils_Array::value('max_related', $query->_returnProperties)) { | |
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. | |
116 | if (CRM_Utils_Array::value('membership_recur_id', $query->_returnProperties)) { | |
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. | |
122 | if (CRM_Utils_Array::value('member_campaign_id', $query->_returnProperties)) { | |
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 | ||
129 | static function where(&$query) { | |
130 | $grouping = $testCondition = NULL; | |
131 | foreach (array_keys($query->_params) as $id) { | |
132 | if (!CRM_Utils_Array::value(0, $query->_params[$id])) { | |
133 | continue; | |
134 | } | |
135 | if (substr($query->_params[$id][0], 0, 7) == 'member_') { | |
136 | if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) { | |
137 | $query->_useDistinct = TRUE; | |
138 | } | |
139 | if ($query->_params[$id][0] == 'member_test') { | |
140 | $testCondition = $id; | |
141 | continue; | |
142 | } | |
143 | $grouping = $query->_params[$id][3]; | |
144 | self::whereClauseSingle($query->_params[$id], $query); | |
145 | } | |
146 | } | |
147 | // Only add test condition if other fields are selected | |
148 | if ($grouping !== NULL && $testCondition && | |
149 | // we dont want to include all tests for sql OR CRM-7827 | |
150 | $query->getOperator() != 'OR' | |
151 | ) { | |
152 | self::whereClauseSingle($query->_params[$testCondition], $query); | |
153 | } | |
154 | } | |
155 | ||
156 | static function whereClauseSingle(&$values, &$query) { | |
157 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
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}"; | |
188 | $date = CRM_Utils_Date::customFormat($value); | |
189 | $format = CRM_Utils_Date::customFormat(CRM_Utils_Date::format(array_reverse($value), '-')); | |
190 | $query->_qill[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op)); | |
191 | } | |
192 | ||
193 | return; | |
194 | ||
195 | case 'member_source': | |
196 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
197 | $value = $strtolower(CRM_Core_DAO::escapeString(trim($value))); | |
198 | ||
199 | $query->_where[$grouping][] = "civicrm_membership.source $op '{$value}'"; | |
200 | $query->_qill[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op)); | |
201 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
202 | return; | |
203 | ||
204 | case 'member_status_id': | |
205 | $status = implode(',', array_keys($value)); | |
206 | ||
207 | if (count($value) > 1) { | |
208 | $op = 'IN'; | |
209 | $status = "({$status})"; | |
210 | } | |
211 | ||
212 | $names = array(); | |
213 | $statusTypes = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'); | |
214 | foreach ($value as $id => $dontCare) { | |
215 | $names[] = $statusTypes[$id]; | |
216 | } | |
217 | $query->_qill[$grouping][] = ts('Membership Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names); | |
218 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.status_id", | |
219 | $op, | |
220 | $status, | |
221 | "Integer" | |
222 | ); | |
223 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
224 | return; | |
225 | ||
226 | case 'member_test': | |
227 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_test", $op, $value, "Boolean"); | |
228 | if ($value) { | |
229 | $query->_qill[$grouping][] = ts('Membership is a Test'); | |
230 | } | |
231 | return; | |
232 | ||
233 | case 'member_auto_renew': | |
234 | $op = "!="; | |
235 | if ($value) { | |
236 | $query->_where[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL"; | |
237 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause( | |
238 | "ccr.contribution_status_id", | |
239 | $op, | |
240 | CRM_Core_DAO::getFieldValue( | |
241 | 'CRM_Core_DAO_OptionValue', | |
242 | 'Cancelled', | |
243 | 'value', | |
244 | 'name' | |
245 | ), | |
246 | "Integer" | |
247 | ); | |
248 | $query->_qill[$grouping][] = ts("Membership is Auto-Renew"); | |
249 | } | |
250 | else { | |
251 | $query->_where[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL"; | |
252 | $query->_qill[$grouping][] = ts("Membership is NOT Auto-Renew"); | |
253 | } | |
254 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
255 | return; | |
256 | ||
257 | case 'member_pay_later': | |
258 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_pay_later", | |
259 | $op, | |
260 | $value, | |
261 | "Integer" | |
262 | ); | |
263 | if ($value) { | |
264 | $query->_qill[$grouping][] = ts("Membership is Pay Later"); | |
265 | } | |
266 | else { | |
267 | $query->_qill[$grouping][] = ts("Membership is NOT Pay Later"); | |
268 | } | |
269 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
270 | return; | |
271 | ||
272 | case 'member_membership_type_id': | |
273 | $mType = implode(',', array_keys($value)); | |
274 | if (count($value) > 1) { | |
275 | $op = 'IN'; | |
276 | $mType = "({$mType})"; | |
277 | } | |
278 | ||
279 | $names = array(); | |
280 | $membershipTypes = CRM_Member_PseudoConstant::membershipType(); | |
281 | foreach ($value as $id => $dontCare) { | |
282 | $names[] = $membershipTypes[$id]; | |
283 | } | |
284 | $query->_qill[$grouping][] = ts('Membership Type %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names); | |
285 | $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.membership_type_id", | |
286 | $op, | |
287 | $mType, | |
288 | "Integer" | |
289 | ); | |
290 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
291 | return; | |
292 | ||
293 | case 'member_id': | |
294 | $query->_where[$grouping][] = " civicrm_membership.id $op $value"; | |
295 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
296 | return; | |
297 | ||
298 | case 'member_is_primary': | |
299 | if ($value) { | |
300 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NULL"; | |
301 | $query->_qill[$grouping][] = ts("Primary Members Only"); | |
302 | } | |
303 | else { | |
304 | $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL"; | |
305 | $query->_qill[$grouping][] = ts("Related Members Only"); | |
306 | } | |
307 | $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1; | |
308 | return; | |
309 | ||
310 | case 'member_campaign_id': | |
311 | $campParams = array( | |
312 | 'op' => $op, | |
313 | 'campaign' => $value, | |
314 | 'grouping' => $grouping, | |
315 | 'tableName' => 'civicrm_membership', | |
316 | ); | |
317 | CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query); | |
318 | return; | |
319 | } | |
320 | } | |
321 | ||
322 | static function from($name, $mode, $side) { | |
323 | $from = NULL; | |
324 | switch ($name) { | |
325 | case 'civicrm_membership': | |
326 | $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id "; | |
327 | $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )"; | |
328 | break; | |
329 | ||
330 | case 'civicrm_membership_type': | |
331 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
332 | $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
333 | } | |
334 | else { | |
335 | $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id "; | |
336 | } | |
337 | break; | |
338 | ||
339 | case 'civicrm_membership_status': | |
340 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
341 | $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
342 | } | |
343 | else { | |
344 | $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id "; | |
345 | } | |
346 | break; | |
347 | ||
348 | case 'civicrm_membership_payment': | |
349 | $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id "; | |
350 | break; | |
351 | } | |
352 | return $from; | |
353 | } | |
354 | ||
355 | static function defaultReturnProperties($mode, | |
356 | $includeCustomFields = TRUE | |
357 | ) { | |
358 | $properties = NULL; | |
359 | if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) { | |
360 | $properties = array( | |
361 | 'contact_type' => 1, | |
362 | 'contact_sub_type' => 1, | |
363 | 'sort_name' => 1, | |
364 | 'display_name' => 1, | |
365 | 'membership_type' => 1, | |
366 | 'member_is_test' => 1, | |
367 | 'member_is_pay_later' => 1, | |
368 | 'join_date' => 1, | |
369 | 'membership_start_date' => 1, | |
370 | 'membership_end_date' => 1, | |
371 | 'membership_source' => 1, | |
372 | 'membership_status' => 1, | |
373 | 'membership_id' => 1, | |
374 | 'owner_membership_id' => 1, | |
375 | 'max_related' => 1, | |
376 | 'membership_recur_id' => 1, | |
377 | 'member_campaign_id' => 1, | |
378 | ); | |
379 | ||
380 | if ($includeCustomFields) { | |
381 | // also get all the custom membership properties | |
382 | $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Membership'); | |
383 | if (!empty($fields)) { | |
384 | foreach ($fields as $name => $dontCare) { | |
385 | $properties[$name] = 1; | |
386 | } | |
387 | } | |
388 | } | |
389 | } | |
390 | ||
391 | return $properties; | |
392 | } | |
393 | ||
394 | static function buildSearchForm(&$form) { | |
395 | foreach (CRM_Member_PseudoConstant::membershipType() as $id => $Name) { | |
396 | $form->_membershipType = &$form->addElement('checkbox', "member_membership_type_id[$id]", NULL, $Name); | |
397 | } | |
398 | ||
399 | ||
400 | foreach (CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label') as $sId => $sName) { | |
401 | $form->_membershipStatus = &$form->addElement('checkbox', "member_status_id[$sId]", NULL, $sName); | |
402 | } | |
403 | ||
404 | $form->addElement('text', 'member_source', ts('Source')); | |
405 | ||
406 | CRM_Core_Form_Date::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE, FALSE); | |
407 | ||
408 | CRM_Core_Form_Date::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE, FALSE); | |
409 | ||
410 | CRM_Core_Form_Date::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE, FALSE); | |
411 | ||
412 | $form->addYesNo('member_is_primary', ts('Primary Member?')); | |
413 | $form->addYesNo('member_pay_later', ts('Pay Later?')); | |
414 | $form->addYesNo('member_auto_renew', ts('Auto-Renew?')); | |
415 | $form->addYesNo('member_test', ts('Membership is a Test?')); | |
416 | ||
417 | // add all the custom searchable fields | |
418 | $extends = array('Membership'); | |
419 | $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends); | |
420 | if ($groupDetails) { | |
421 | $form->assign('membershipGroupTree', $groupDetails); | |
422 | foreach ($groupDetails as $group) { | |
423 | foreach ($group['fields'] as $field) { | |
424 | $fieldId = $field['id']; | |
425 | $elementName = 'custom_' . $fieldId; | |
426 | CRM_Core_BAO_CustomField::addQuickFormElement($form, | |
427 | $elementName, | |
428 | $fieldId, | |
429 | FALSE, FALSE, TRUE | |
430 | ); | |
431 | } | |
432 | } | |
433 | } | |
434 | ||
435 | CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'member_campaign_id'); | |
436 | ||
437 | $form->assign('validCiviMember', TRUE); | |
438 | $form->setDefaults(array('member_test' => 0)); | |
439 | } | |
440 | ||
441 | static function searchAction(&$row, $id) {} | |
442 | ||
443 | static function addShowHide(&$showHide) { | |
444 | $showHide->addHide('memberForm'); | |
445 | $showHide->addShow('memberForm_show'); | |
446 | } | |
447 | ||
448 | static function tableNames(&$tables) { | |
449 | //add membership table | |
450 | if (CRM_Utils_Array::value('civicrm_membership_log', $tables) || CRM_Utils_Array::value('civicrm_membership_status', $tables) || CRM_Utils_Array::value('civicrm_membership_type', $tables)) { | |
451 | $tables = array_merge(array('civicrm_membership' => 1), $tables); | |
452 | } | |
453 | } | |
454 | } | |
455 |