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