3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
33 class CRM_Member_BAO_Query
{
36 * Get available fields.
40 public static function &getFields() {
41 $fields = CRM_Member_BAO_Membership
::exportableFields();
46 * If membership are involved, add the specific membership fields.
48 * @param CRM_Contact_BAO_Query $query
50 public static function select(&$query) {
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_')
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;
62 if (!empty($query->_returnProperties
['membership_type'])) {
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;
70 if (!empty($query->_returnProperties
['join_date'])) {
71 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
72 $query->_element
['join_date'] = 1;
76 if (!empty($query->_returnProperties
['membership_source'])) {
77 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
78 $query->_element
['membership_source'] = 1;
82 if (!empty($query->_returnProperties
['membership_status'])) {
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;
89 if (!empty($query->_returnProperties
['membership_status_id'])) {
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;
96 //add start date / end date
97 if (!empty($query->_returnProperties
['membership_start_date'])) {
98 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
99 $query->_element
['membership_start_date'] = 1;
102 if (!empty($query->_returnProperties
['membership_end_date'])) {
103 $query->_select
['membership_end_date'] = "civicrm_membership.end_date as membership_end_date";
104 $query->_element
['membership_end_date'] = 1;
107 //add owner_membership_id
108 if (!empty($query->_returnProperties
['owner_membership_id'])) {
109 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
110 $query->_element
['owner_membership_id'] = 1;
113 if (!empty($query->_returnProperties
['max_related'])) {
114 $query->_select
['max_related'] = "civicrm_membership.max_related as max_related";
115 $query->_element
['max_related'] = 1;
117 //add recur id w/o taking contribution table in join.
118 if (!empty($query->_returnProperties
['membership_recur_id'])) {
119 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
120 $query->_element
['membership_recur_id'] = 1;
124 if (!empty($query->_returnProperties
['member_campaign_id'])) {
125 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
126 $query->_element
['member_campaign_id'] = 1;
132 * Generate where clause.
134 * @param CRM_Contact_BAO_Query $query
136 public static function where(&$query) {
137 foreach (array_keys($query->_params
) as $id) {
138 if (empty($query->_params
[$id][0])) {
141 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
142 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
143 $query->_useDistinct
= TRUE;
145 self
::whereClauseSingle($query->_params
[$id], $query);
151 * Generate where for a single parameter.
153 * @param array $values
154 * @param CRM_Contact_BAO_Query $query
156 public static function whereClauseSingle(&$values, &$query) {
157 list($name, $op, $value, $grouping) = $values;
159 case 'member_join_date_low':
160 case 'member_join_date_high':
161 $query->dateQueryBuilder($values,
162 'civicrm_membership', 'member_join_date', 'join_date',
167 case 'member_start_date_low':
168 case 'member_start_date_high':
169 $query->dateQueryBuilder($values,
170 'civicrm_membership', 'member_start_date', 'start_date',
175 case 'member_end_date_low':
176 case 'member_end_date_high':
177 $query->dateQueryBuilder($values,
178 'civicrm_membership', 'member_end_date', 'end_date',
183 case 'member_join_date':
185 $date = CRM_Utils_Date
::format($value);
187 $query->_where
[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
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));
194 case 'member_source':
195 case 'membership_source':
196 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
197 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
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;
204 // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6.
205 case 'member_status_id':
206 case 'member_membership_type_id':
207 if (is_array($value)) {
209 $value = array_keys($value);
211 case 'membership_status':
212 case 'membership_status_id':
213 case 'membership_type':
214 case 'membership_type_id':
215 // CRM-17075 we are specifically handling the possibility we are dealing with the entity reference field
216 // for membership_type_id here (although status would be handled if converted). The unhandled pathway at the moment
217 // is from groupContactCache::load and this is a small fix to get the entity reference field to work.
218 // However, it would seem the larger fix would be to NOT invoke the form formValues for
219 // the load function. The where clause and the whereTables are saved so they should suffice to generate the query
220 // to get a contact list. But, better to deal with in 4.8 now...
221 if (is_string($value) && strpos($value, ',') && $op == '=') {
222 $value = array('IN' => explode(',', $value));
224 case 'membership_id':
225 case 'member_id': // CRM-18523 Updated to membership_id but kept member_id case for backwards compatibility
226 case 'member_campaign_id':
228 if (strpos($name, 'status') !== FALSE) {
230 $qillName = ts('Membership Status');
232 elseif ($name == 'membership_id' ||
$name == 'member_id') {
234 $qillName = ts('Membership ID');
236 elseif ($name == 'member_campaign_id') {
237 $name = 'campaign_id';
238 $qillName = ts('Campaign');
241 $name = 'membership_type_id';
242 $qillName = ts('Membership Type');
244 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.$name",
249 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op);
250 $query->_qill
[$grouping][] = $qillName . ' ' . $op . ' ' . $value;
251 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
255 // We don't want to include all tests for sql OR CRM-7827
256 if (!$value ||
$query->getOperator() != 'OR') {
257 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
259 $query->_qill
[$grouping][] = ts('Membership is a Test');
262 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
265 case 'member_auto_renew':
267 $where = $qill = array();
268 foreach ($value as $val) {
270 $where[] = ' civicrm_membership.contribution_recur_id IS NULL';
271 $qill[] = ts('Membership is NOT Auto-Renew');
274 $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . CRM_Contact_BAO_Query
::buildClause(
275 'ccr.contribution_status_id',
279 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
283 $qill[] = ts('Membership is Auto-Renew and In Progress');
286 $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
287 CRM_Contact_BAO_Query
::buildClause(
288 'ccr.contribution_status_id',
292 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
296 $qill[] = ts('Membership is Auto-Renew and Failed');
299 $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
300 CRM_Contact_BAO_Query
::buildClause(
301 'ccr.contribution_status_id',
305 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
309 $qill[] = ts('Membership is Auto-Renew and Cancelled');
312 $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ccr.end_date IS NOT NULL AND ccr.end_date < NOW()';
313 $qill[] = ts('Membership is Auto-Renew and Ended');
316 $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL';
317 $qill[] = ts('Membership is Auto-Renew');
320 if (!empty($where)) {
321 $query->_where
[$grouping][] = implode(' OR ', $where);
322 $query->_qill
[$grouping][] = implode(' OR ', $qill);
325 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
328 case 'member_pay_later':
329 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
335 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
338 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
340 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
343 case 'member_is_primary':
345 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
346 $query->_qill
[$grouping][] = ts("Primary Members Only");
349 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
350 $query->_qill
[$grouping][] = ts("Related Members Only");
352 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
355 case 'member_is_override':
356 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_override", $op, $value, "Boolean");
357 $query->_qill
[$grouping][] = $value ?
ts("Membership Status Is Overriden") : ts("Membership Status Is NOT Overriden");
358 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
364 * Generate from clause.
366 * @param string $name
368 * @param string $side
372 public static function from($name, $mode, $side) {
375 case 'civicrm_membership':
376 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
377 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
380 case 'civicrm_membership_type':
381 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
382 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
385 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
389 case 'civicrm_membership_status':
390 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
391 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
394 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
398 case 'civicrm_membership_payment':
399 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
406 * Get default return properties.
408 * @param string $mode
409 * @param bool $includeCustomFields
413 public static function defaultReturnProperties(
415 $includeCustomFields = TRUE
418 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
421 'contact_sub_type' => 1,
424 'membership_type' => 1,
425 'member_is_test' => 1,
426 'member_is_pay_later' => 1,
428 'membership_start_date' => 1,
429 'membership_end_date' => 1,
430 'membership_source' => 1,
431 'membership_status' => 1,
432 'membership_id' => 1,
433 'owner_membership_id' => 1,
435 'membership_recur_id' => 1,
436 'member_campaign_id' => 1,
437 'member_is_override' => 1,
438 'member_auto_renew' => 1,
441 if ($includeCustomFields) {
442 // also get all the custom membership properties
443 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
444 if (!empty($fields)) {
445 foreach ($fields as $name => $dontCare) {
446 $properties[$name] = 1;
456 * Build the search form.
458 * @param CRM_Core_Form $form
460 public static function buildSearchForm(&$form) {
461 $membershipStatus = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label', FALSE, FALSE);
462 $form->add('select', 'membership_status_id', ts('Membership Status'), $membershipStatus, FALSE, array(
463 'id' => 'membership_status_id',
464 'multiple' => 'multiple',
465 'class' => 'crm-select2',
468 $form->addEntityRef('membership_type_id', ts('Membership Type'), array(
469 'entity' => 'MembershipType',
471 'placeholder' => ts('- any -'),
472 'select' => array('minimumInputLength' => 0),
475 $form->addElement('text', 'member_source', ts('Source'));
476 $form->addElement('text', 'membership_id', ts('Membership ID'));
478 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
479 $form->addElement('hidden', 'member_join_date_range_error');
481 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
482 $form->addElement('hidden', 'member_start_date_range_error');
484 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
485 $form->addElement('hidden', 'member_end_date_range_error');
487 $form->addFormRule(array('CRM_Member_BAO_Query', 'formRule'), $form);
489 $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
490 $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
492 $form->add('select', 'member_auto_renew',
493 ts('Auto-Renew Subscription Status?'),
495 '1' => ts('- None -'),
496 '2' => ts('In Progress'),
498 '4' => ts('Cancelled'),
502 FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
505 $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
506 $form->addYesNo('member_is_override', ts('Membership Status Is Overriden?'), TRUE);
508 // add all the custom searchable fields
509 $extends = array('Membership');
510 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
512 $form->assign('membershipGroupTree', $groupDetails);
513 foreach ($groupDetails as $group) {
514 foreach ($group['fields'] as $field) {
515 $fieldId = $field['id'];
516 $elementName = 'custom_' . $fieldId;
517 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE);
522 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
524 $form->assign('validCiviMember', TRUE);
525 $form->setDefaults(array('member_test' => 0));
529 * Possibly un-required function.
534 public static function searchAction(&$row, $id) {
538 * Add membership table.
540 * @param array $tables
542 public static function tableNames(&$tables) {
543 if (!empty($tables['civicrm_membership_log']) ||
!empty($tables['civicrm_membership_status']) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
544 $tables = array_merge(array('civicrm_membership' => 1), $tables);
551 * @param array $fields
552 * @param array $files
553 * @param CRM_Core_Form $form
557 public static function formRule($fields, $files, $form) {
560 if ((empty($fields['member_join_date_low']) ||
empty($fields['member_join_date_high'])) && (empty($fields['member_start_date_low']) ||
empty($fields['member_start_date_high'])) && (empty($fields['member_end_date_low']) ||
empty($fields['member_end_date_high']))) {
564 CRM_Utils_Rule
::validDateRange($fields, 'member_join_date', $errors, ts('Member Since'));
565 CRM_Utils_Rule
::validDateRange($fields, 'member_start_date', $errors, ts('Start Date'));
566 CRM_Utils_Rule
::validDateRange($fields, 'member_end_date', $errors, ts('End Date'));
568 return empty($errors) ?
TRUE : $errors;