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