CRM/Member/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Member_BAO_Query extends CRM_Core_BAO_Query {
  34
  35   /**
  36    * Get available fields.
  37    *
  38    * @return array
  39    */
  40   public 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    *
  48    * @param CRM_Contact_BAO_Query $query
  49    */
  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_')
  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
  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;
  67       }
  68
  69       //add join date
  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;
  73       }
  74
  75       //add source
  76       if (!empty($query->_returnProperties['membership_source'])) {
  77         $query->_select['membership_source'] = "civicrm_membership.source as membership_source";
  78         $query->_element['membership_source'] = 1;
  79       }
  80
  81       //add status
  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;
  87       }
  88
  89       if (!empty($query->_returnProperties['membership_is_current_member'])) {
  90         $query->_select['is_current_member'] = "civicrm_membership_status.is_current_member as is_current_member";
  91         $query->_element['is_current_member'] = 1;
  92         $query->_tables['civicrm_membership_status'] = 1;
  93         $query->_whereTables['civicrm_membership_status'] = 1;
  94       }
  95
  96       if (!empty($query->_returnProperties['membership_status_id'])) {
  97         $query->_select['status_id'] = "civicrm_membership_status.id as status_id";
  98         $query->_element['status_id'] = 1;
  99         $query->_tables['civicrm_membership_status'] = 1;
 100         $query->_whereTables['civicrm_membership_status'] = 1;
 101       }
 102
 103       //add start date / end date
 104       if (!empty($query->_returnProperties['membership_start_date'])) {
 105         $query->_select['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
 106         $query->_element['membership_start_date'] = 1;
 107       }
 108
 109       if (!empty($query->_returnProperties['membership_end_date'])) {
 110         $query->_select['membership_end_date'] = "civicrm_membership.end_date as  membership_end_date";
 111         $query->_element['membership_end_date'] = 1;
 112       }
 113
 114       //add owner_membership_id
 115       if (!empty($query->_returnProperties['owner_membership_id'])) {
 116         $query->_select['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
 117         $query->_element['owner_membership_id'] = 1;
 118       }
 119       //add max_related
 120       if (!empty($query->_returnProperties['max_related'])) {
 121         $query->_select['max_related'] = "civicrm_membership.max_related as max_related";
 122         $query->_element['max_related'] = 1;
 123       }
 124       //add recur id w/o taking contribution table in join.
 125       if (!empty($query->_returnProperties['membership_recur_id'])) {
 126         $query->_select['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
 127         $query->_element['membership_recur_id'] = 1;
 128       }
 129
 130       //add campaign id.
 131       if (!empty($query->_returnProperties['member_campaign_id'])) {
 132         $query->_select['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
 133         $query->_element['member_campaign_id'] = 1;
 134       }
 135     }
 136   }
 137
 138   /**
 139    * Generate where clause.
 140    *
 141    * @param CRM_Contact_BAO_Query $query
 142    */
 143   public static function where(&$query) {
 144     foreach (array_keys($query->_params) as $id) {
 145       if (empty($query->_params[$id][0])) {
 146         continue;
 147       }
 148       if (substr($query->_params[$id][0], 0, 7) == 'member_' || substr($query->_params[$id][0], 0, 11) == 'membership_') {
 149         if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
 150           $query->_useDistinct = TRUE;
 151         }
 152         self::whereClauseSingle($query->_params[$id], $query);
 153       }
 154     }
 155   }
 156
 157   /**
 158    * Generate where for a single parameter.
 159    *
 160    * @param array $values
 161    * @param CRM_Contact_BAO_Query $query
 162    */
 163   public static function whereClauseSingle(&$values, &$query) {
 164     list($name, $op, $value, $grouping) = $values;
 165     switch ($name) {
 166       case 'member_join_date_low':
 167       case 'member_join_date_high':
 168         $query->dateQueryBuilder($values,
 169           'civicrm_membership', 'member_join_date', 'join_date',
 170           'Member Since'
 171         );
 172         return;
 173
 174       case 'membership_start_date':
 175       case 'member_start_date_low':
 176       case 'member_start_date_high':
 177         $fldName = str_replace(['_low', '_high'], '', $name);
 178         $query->dateQueryBuilder($values,
 179           'civicrm_membership', $fldName, 'start_date',
 180           'Start Date'
 181         );
 182         return;
 183
 184       case 'membership_end_date':
 185       case 'member_end_date_low':
 186       case 'member_end_date_high':
 187         $fldName = str_replace(['_low', '_high'], '', $name);
 188         $query->dateQueryBuilder($values,
 189           'civicrm_membership', $fldName, 'end_date',
 190           'End Date'
 191         );
 192         return;
 193
 194       case 'member_join_date':
 195         $op = '>=';
 196         $date = CRM_Utils_Date::format($value);
 197         if ($date) {
 198           $query->_where[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
 199           $format = CRM_Utils_Date::customFormat(CRM_Utils_Date::format(array_reverse($value), '-'));
 200           $query->_qill[$grouping][] = ts('Member Since %2 %1', [1 => $format, 2 => $op]);
 201         }
 202
 203         return;
 204
 205       case 'member_source':
 206       case 'membership_source':
 207         $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 208         $value = $strtolower(CRM_Core_DAO::escapeString(trim($value)));
 209
 210         $query->_where[$grouping][] = "civicrm_membership.source $op '{$value}'";
 211         $query->_qill[$grouping][] = ts('Source %2 %1', [1 => $value, 2 => $op]);
 212         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 213         return;
 214
 215       // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6.
 216       case 'member_status_id':
 217       case 'member_membership_type_id':
 218         if (is_array($value)) {
 219           $op = 'IN';
 220           $value = array_keys($value);
 221         }
 222       case 'membership_status':
 223       case 'membership_status_id':
 224       case 'membership_type':
 225       case 'membership_type_id':
 226         // CRM-17075 we are specifically handling the possibility we are dealing with the entity reference field
 227         // for membership_type_id here (although status would be handled if converted). The unhandled pathway at the moment
 228         // is from groupContactCache::load and this is a small fix to get the entity reference field to work.
 229         // However, it would seem the larger fix would be to NOT invoke the form formValues for
 230         // the load function. The where clause and the whereTables are saved so they should suffice to generate the query
 231         // to get a contact list. But, better to deal with in 4.8 now...
 232         if (is_string($value) && strpos($value, ',') && $op == '=') {
 233           $value = ['IN' => explode(',', $value)];
 234         }
 235       case 'membership_id':
 236         // CRM-18523 Updated to membership_id but kept member_id case for backwards compatibility
 237       case 'member_id':
 238       case 'member_campaign_id':
 239
 240         if (strpos($name, 'status') !== FALSE) {
 241           $name = 'status_id';
 242           $qillName = ts('Membership Status');
 243         }
 244         elseif ($name == 'membership_id' || $name == 'member_id') {
 245           $name = 'id';
 246           $qillName = ts('Membership ID');
 247         }
 248         elseif ($name == 'member_campaign_id') {
 249           $name = 'campaign_id';
 250           $qillName = ts('Campaign');
 251         }
 252         else {
 253           $name = 'membership_type_id';
 254           $qillName = ts('Membership Type');
 255         }
 256         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.$name",
 257           $op,
 258           $value,
 259           "Integer"
 260         );
 261         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op);
 262         $query->_qill[$grouping][] = $qillName . ' ' . $op . ' ' . $value;
 263         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 264         return;
 265
 266       case 'membership_is_current_member':
 267         // We don't want to include all tests for sql OR CRM-7827
 268         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership_status.is_current_member", $op, $value, "Boolean");
 269         $query->_qill[$grouping][] = $value ? ts('Is a current member') : ts('Is a non-current member');
 270         $query->_tables['civicrm_membership_status'] = $query->_whereTables['civicrm_membership_status'] = 1;
 271         return;
 272
 273       case 'member_test':
 274         // We don't want to include all tests for sql OR CRM-7827
 275         if (!$value || $query->getOperator() != 'OR') {
 276           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
 277           if ($value) {
 278             $query->_qill[$grouping][] = ts('Membership is a Test');
 279           }
 280         }
 281         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 282         return;
 283
 284       case 'member_auto_renew':
 285         $op = '=';
 286         $where = $qill = [];
 287         foreach ($value as $val) {
 288           if ($val == 1) {
 289             $where[] = ' civicrm_membership.contribution_recur_id IS NULL';
 290             $qill[] = ts('Membership is NOT Auto-Renew');
 291           }
 292           elseif ($val == 2) {
 293             $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . CRM_Contact_BAO_Query::buildClause(
 294                 'ccr.contribution_status_id',
 295                 $op,
 296                 array_search(
 297                   'In Progress',
 298                   CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
 299                 ),
 300                 'Integer'
 301               );
 302             $qill[] = ts('Membership is Auto-Renew and In Progress');
 303           }
 304           elseif ($val == 3) {
 305             $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
 306               CRM_Contact_BAO_Query::buildClause(
 307                 'ccr.contribution_status_id',
 308                 $op,
 309                 array_search(
 310                   'Failed',
 311                   CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
 312                 ),
 313                 'Integer'
 314               );
 315             $qill[] = ts('Membership is Auto-Renew and Failed');
 316           }
 317           elseif ($val == 4) {
 318             $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
 319               CRM_Contact_BAO_Query::buildClause(
 320                 'ccr.contribution_status_id',
 321                 $op,
 322                 array_search(
 323                   'Cancelled',
 324                   CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
 325                 ),
 326                 'Integer'
 327               );
 328             $qill[] = ts('Membership is Auto-Renew and Cancelled');
 329           }
 330           elseif ($val == 5) {
 331             $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ccr.end_date IS NOT NULL AND ccr.end_date < NOW()';
 332             $qill[] = ts('Membership is Auto-Renew and Ended');
 333           }
 334           elseif ($val == 6) {
 335             $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL';
 336             $qill[] = ts('Membership is Auto-Renew');
 337           }
 338         }
 339         if (!empty($where)) {
 340           $query->_where[$grouping][] = implode(' OR ', $where);
 341           $query->_qill[$grouping][] = implode(' OR ', $qill);
 342         }
 343
 344         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 345         return;
 346
 347       case 'member_pay_later':
 348         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_pay_later",
 349           $op,
 350           $value,
 351           "Integer"
 352         );
 353         if ($value) {
 354           $query->_qill[$grouping][] = ts("Membership is Pay Later");
 355         }
 356         else {
 357           $query->_qill[$grouping][] = ts("Membership is NOT Pay Later");
 358         }
 359         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 360         return;
 361
 362       case 'member_is_primary':
 363         if ($value) {
 364           $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
 365           $query->_qill[$grouping][] = ts("Primary Members Only");
 366         }
 367         else {
 368           $query->_where[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
 369           $query->_qill[$grouping][] = ts("Related Members Only");
 370         }
 371         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 372         return;
 373
 374       case 'member_is_override':
 375         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_membership.is_override", $op, $value, "Boolean");
 376         $query->_qill[$grouping][] = $value ? ts("Membership Status Is Overriden") : ts("Membership Status Is NOT Overriden");
 377         $query->_tables['civicrm_membership'] = $query->_whereTables['civicrm_membership'] = 1;
 378         return;
 379     }
 380   }
 381
 382   /**
 383    * Generate from clause.
 384    *
 385    * @param string $name
 386    * @param int $mode
 387    * @param string $side
 388    *
 389    * @return string
 390    */
 391   public static function from($name, $mode, $side) {
 392     $from = NULL;
 393     switch ($name) {
 394       case 'civicrm_membership':
 395         $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
 396         $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
 397         break;
 398
 399       case 'civicrm_membership_type':
 400         if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) {
 401           $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
 402         }
 403         else {
 404           $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
 405         }
 406         break;
 407
 408       case 'civicrm_membership_status':
 409         if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) {
 410           $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
 411         }
 412         else {
 413           $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
 414         }
 415         break;
 416
 417       case 'civicrm_membership_payment':
 418         $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
 419         break;
 420     }
 421     return $from;
 422   }
 423
 424   /**
 425    * Get default return properties.
 426    *
 427    * @param string $mode
 428    * @param bool $includeCustomFields
 429    *
 430    * @return array|null
 431    */
 432   public static function defaultReturnProperties(
 433     $mode,
 434     $includeCustomFields = TRUE
 435   ) {
 436     $properties = NULL;
 437     if ($mode & CRM_Contact_BAO_Query::MODE_MEMBER) {
 438       $properties = [
 439         'contact_type' => 1,
 440         'contact_sub_type' => 1,
 441         'sort_name' => 1,
 442         'display_name' => 1,
 443         'membership_type' => 1,
 444         'member_is_test' => 1,
 445         'member_is_pay_later' => 1,
 446         'join_date' => 1,
 447         'membership_start_date' => 1,
 448         'membership_end_date' => 1,
 449         'membership_source' => 1,
 450         'membership_status' => 1,
 451         'membership_id' => 1,
 452         'owner_membership_id' => 1,
 453         'max_related' => 1,
 454         'membership_recur_id' => 1,
 455         'member_campaign_id' => 1,
 456         'member_is_override' => 1,
 457         'member_auto_renew' => 1,
 458       ];
 459
 460       if ($includeCustomFields) {
 461         // also get all the custom membership properties
 462         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Membership');
 463         if (!empty($fields)) {
 464           foreach ($fields as $name => $dontCare) {
 465             $properties[$name] = 1;
 466           }
 467         }
 468       }
 469     }
 470
 471     return $properties;
 472   }
 473
 474   /**
 475    * Build the search form.
 476    *
 477    * @param CRM_Core_Form $form
 478    */
 479   public static function buildSearchForm(&$form) {
 480     $membershipStatus = CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label', FALSE, FALSE);
 481     $form->add('select', 'membership_status_id', ts('Membership Status'), $membershipStatus, FALSE, [
 482       'id' => 'membership_status_id',
 483       'multiple' => 'multiple',
 484       'class' => 'crm-select2',
 485     ]);
 486
 487     $form->addEntityRef('membership_type_id', ts('Membership Type'), [
 488       'entity' => 'MembershipType',
 489       'multiple' => TRUE,
 490       'placeholder' => ts('- any -'),
 491       'select' => ['minimumInputLength' => 0],
 492     ]);
 493
 494     $form->addElement('text', 'member_source', ts('Source'));
 495     $form->add('number', 'membership_id', ts('Membership ID'), ['class' => 'four', 'min' => 1]);
 496
 497     CRM_Core_Form_Date::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
 498     $form->addElement('hidden', 'member_join_date_range_error');
 499
 500     CRM_Core_Form_Date::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
 501     $form->addElement('hidden', 'member_start_date_range_error');
 502
 503     CRM_Core_Form_Date::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
 504     $form->addElement('hidden', 'member_end_date_range_error');
 505
 506     $form->addFormRule(['CRM_Member_BAO_Query', 'formRule'], $form);
 507
 508     $form->addYesNo('membership_is_current_member', ts('Current Member?'), TRUE);
 509     $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
 510     $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
 511
 512     $form->add('select', 'member_auto_renew',
 513       ts('Auto-Renew Subscription Status?'),
 514       [
 515         '1' => ts('- None -'),
 516         '2' => ts('In Progress'),
 517         '3' => ts('Failed'),
 518         '4' => ts('Cancelled'),
 519         '5' => ts('Ended'),
 520         '6' => ts('Any'),
 521       ],
 522       FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]
 523     );
 524
 525     $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
 526     $form->addYesNo('member_is_override', ts('Membership Status Is Overriden?'), TRUE);
 527
 528     self::addCustomFormFields($form, ['Membership']);
 529
 530     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'member_campaign_id');
 531
 532     $form->assign('validCiviMember', TRUE);
 533     $form->setDefaults(['member_test' => 0]);
 534   }
 535
 536   /**
 537    * Add membership table.
 538    *
 539    * @param array $tables
 540    */
 541   public static function tableNames(&$tables) {
 542     if (!empty($tables['civicrm_membership_log']) || !empty($tables['civicrm_membership_status']) || CRM_Utils_Array::value('civicrm_membership_type', $tables)) {
 543       $tables = array_merge(['civicrm_membership' => 1], $tables);
 544     }
 545   }
 546
 547   /**
 548    * Custom form rules.
 549    *
 550    * @param array $fields
 551    * @param array $files
 552    * @param CRM_Core_Form $form
 553    *
 554    * @return bool|array
 555    */
 556   public static function formRule($fields, $files, $form) {
 557     $errors = [];
 558
 559     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']))) {
 560       return TRUE;
 561     }
 562
 563     CRM_Utils_Rule::validDateRange($fields, 'member_join_date', $errors, ts('Member Since'));
 564     CRM_Utils_Rule::validDateRange($fields, 'member_start_date', $errors, ts('Start Date'));
 565     CRM_Utils_Rule::validDateRange($fields, 'member_end_date', $errors, ts('End Date'));
 566
 567     return empty($errors) ? TRUE : $errors;
 568   }
 569
 570 }