CRM/Member/Import/Parser/Membership.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  * $Id$
  33  *
  34  */
  35
  36
  37 require_once 'api/api.php';
  38
  39 /**
  40  * class to parse membership csv files
  41  */
  42 class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser {
  43
  44   protected $_mapperKeys;
  45
  46   private $_contactIdIndex;
  47   private $_totalAmountIndex;
  48   private $_membershipTypeIndex;
  49   private $_membershipStatusIndex;
  50
  51   /**
  52    * Array of metadata for all available fields.
  53    *
  54    * @var array
  55    */
  56   protected $fieldMetadata = [];
  57
  58   /**
  59    * Array of successfully imported membership id's
  60    *
  61    * @var array
  62    */
  63   protected $_newMemberships;
  64
  65   /**
  66    * Class constructor.
  67    *
  68    * @param $mapperKeys
  69    */
  70   public function __construct($mapperKeys) {
  71     parent::__construct();
  72     $this->_mapperKeys = $mapperKeys;
  73   }
  74
  75   /**
  76    * The initializer code, called before the processing
  77    *
  78    * @return void
  79    */
  80   public function init() {
  81     $this->fieldMetadata = CRM_Member_BAO_Membership::importableFields($this->_contactType, FALSE);
  82
  83     foreach ($this->fieldMetadata as $name => $field) {
  84       // @todo - we don't really need to do all this.... fieldMetadata is just fine to use as is.
  85       $field['type'] = CRM_Utils_Array::value('type', $field, CRM_Utils_Type::T_INT);
  86       $field['dataPattern'] = CRM_Utils_Array::value('dataPattern', $field, '//');
  87       $field['headerPattern'] = CRM_Utils_Array::value('headerPattern', $field, '//');
  88       $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
  89     }
  90
  91     $this->_newMemberships = [];
  92
  93     $this->setActiveFields($this->_mapperKeys);
  94
  95     // FIXME: we should do this in one place together with Form/MapField.php
  96     $this->_contactIdIndex = -1;
  97     $this->_membershipTypeIndex = -1;
  98     $this->_membershipStatusIndex = -1;
  99
 100     $index = 0;
 101     foreach ($this->_mapperKeys as $key) {
 102       switch ($key) {
 103         case 'membership_contact_id':
 104           $this->_contactIdIndex = $index;
 105           break;
 106
 107         case 'membership_type_id':
 108           $this->_membershipTypeIndex = $index;
 109           break;
 110
 111         case 'status_id':
 112           $this->_membershipStatusIndex = $index;
 113           break;
 114       }
 115       $index++;
 116     }
 117   }
 118
 119   /**
 120    * Handle the values in mapField mode.
 121    *
 122    * @param array $values
 123    *   The array of values belonging to this line.
 124    *
 125    * @return bool
 126    */
 127   public function mapField(&$values) {
 128     return CRM_Import_Parser::VALID;
 129   }
 130
 131   /**
 132    * Handle the values in preview mode.
 133    *
 134    * @param array $values
 135    *   The array of values belonging to this line.
 136    *
 137    * @return bool
 138    *   the result of this processing
 139    */
 140   public function preview(&$values) {
 141     return $this->summary($values);
 142   }
 143
 144   /**
 145    * Handle the values in summary mode.
 146    *
 147    * @param array $values
 148    *   The array of values belonging to this line.
 149    *
 150    * @return bool
 151    *   the result of this processing
 152    */
 153   public function summary(&$values) {
 154     $erroneousField = NULL;
 155     $response = $this->setActiveFieldValues($values, $erroneousField);
 156
 157     $errorRequired = FALSE;
 158
 159     if ($this->_membershipTypeIndex < 0) {
 160       $errorRequired = TRUE;
 161     }
 162     else {
 163       $errorRequired = !CRM_Utils_Array::value($this->_membershipTypeIndex, $values);
 164     }
 165
 166     if ($errorRequired) {
 167       array_unshift($values, ts('Missing required fields'));
 168       return CRM_Import_Parser::ERROR;
 169     }
 170
 171     $params = $this->getActiveFieldParams();
 172     $errorMessage = NULL;
 173
 174     //To check whether start date or join date is provided
 175     if (empty($params['membership_start_date']) && empty($params['join_date'])) {
 176       $errorMessage = 'Membership Start Date is required to create a memberships.';
 177       CRM_Contact_Import_Parser_Contact::addToErrorMsg('Start Date', $errorMessage);
 178     }
 179
 180     //for date-Formats
 181     $session = CRM_Core_Session::singleton();
 182     $dateType = $session->get('dateTypes');
 183     foreach ($params as $key => $val) {
 184
 185       if ($val) {
 186         switch ($key) {
 187           case 'join_date':
 188             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
 189               if (!CRM_Utils_Rule::date($params[$key])) {
 190                 CRM_Contact_Import_Parser_Contact::addToErrorMsg('Member Since', $errorMessage);
 191               }
 192             }
 193             else {
 194               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Member Since', $errorMessage);
 195             }
 196             break;
 197
 198           case 'membership_start_date':
 199             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
 200               if (!CRM_Utils_Rule::date($params[$key])) {
 201                 CRM_Contact_Import_Parser_Contact::addToErrorMsg('Start Date', $errorMessage);
 202               }
 203             }
 204             else {
 205               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Start Date', $errorMessage);
 206             }
 207             break;
 208
 209           case 'membership_end_date':
 210             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
 211               if (!CRM_Utils_Rule::date($params[$key])) {
 212                 CRM_Contact_Import_Parser_Contact::addToErrorMsg('End date', $errorMessage);
 213               }
 214             }
 215             else {
 216               CRM_Contact_Import_Parser_Contact::addToErrorMsg('End date', $errorMessage);
 217             }
 218             break;
 219
 220           case 'status_override_end_date':
 221             if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
 222               if (!CRM_Utils_Rule::date($params[$key])) {
 223                 CRM_Contact_Import_Parser_Contact::addToErrorMsg('Status Override End Date', $errorMessage);
 224               }
 225             }
 226             else {
 227               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Status Override End Date', $errorMessage);
 228             }
 229             break;
 230
 231           case 'membership_type_id':
 232             // @todo - squish into membership status - can use same lines here too.
 233             $membershipTypes = CRM_Member_PseudoConstant::membershipType();
 234             if (!CRM_Utils_Array::crmInArray($val, $membershipTypes) &&
 235               !array_key_exists($val, $membershipTypes)
 236             ) {
 237               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Membership Type', $errorMessage);
 238             }
 239             break;
 240
 241           case 'status_id':
 242             if (!empty($val) && !$this->parsePseudoConstantField($val, $this->fieldMetadata[$key])) {
 243               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Membership Status', $errorMessage);
 244             }
 245             break;
 246
 247           case 'email':
 248             if (!CRM_Utils_Rule::email($val)) {
 249               CRM_Contact_Import_Parser_Contact::addToErrorMsg('Email Address', $errorMessage);
 250             }
 251         }
 252       }
 253     }
 254     //date-Format part ends
 255
 256     $params['contact_type'] = 'Membership';
 257
 258     //checking error in custom data
 259     CRM_Contact_Import_Parser_Contact::isErrorInCustomData($params, $errorMessage);
 260
 261     if ($errorMessage) {
 262       $tempMsg = "Invalid value for field(s) : $errorMessage";
 263       array_unshift($values, $tempMsg);
 264       $errorMessage = NULL;
 265       return CRM_Import_Parser::ERROR;
 266     }
 267
 268     return CRM_Import_Parser::VALID;
 269   }
 270
 271   /**
 272    * Handle the values in import mode.
 273    *
 274    * @param int $onDuplicate
 275    *   The code for what action to take on duplicates.
 276    * @param array $values
 277    *   The array of values belonging to this line.
 278    *
 279    * @return bool
 280    *   the result of this processing
 281    */
 282   public function import($onDuplicate, &$values) {
 283     try {
 284       // first make sure this is a valid line
 285       $response = $this->summary($values);
 286       if ($response != CRM_Import_Parser::VALID) {
 287         return $response;
 288       }
 289
 290       $params = $this->getActiveFieldParams();
 291
 292       //assign join date equal to start date if join date is not provided
 293       if (empty($params['join_date']) && !empty($params['membership_start_date'])) {
 294         $params['join_date'] = $params['membership_start_date'];
 295       }
 296
 297       $session = CRM_Core_Session::singleton();
 298       $dateType = $session->get('dateTypes');
 299       $formatted = [];
 300       $customDataType = !empty($params['contact_type']) ? $params['contact_type'] : 'Membership';
 301       $customFields = CRM_Core_BAO_CustomField::getFields($customDataType);
 302
 303       // don't add to recent items, CRM-4399
 304       $formatted['skipRecentView'] = TRUE;
 305       $dateLabels = [
 306         'join_date' => ts('Member Since'),
 307         'membership_start_date' => ts('Start Date'),
 308         'membership_end_date' => ts('End Date'),
 309       ];
 310       foreach ($params as $key => $val) {
 311         if ($val) {
 312           switch ($key) {
 313             case 'join_date':
 314             case 'membership_start_date':
 315             case 'membership_end_date':
 316               if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
 317                 if (!CRM_Utils_Rule::date($params[$key])) {
 318                   CRM_Contact_Import_Parser_Contact::addToErrorMsg($dateLabels[$key], $errorMessage);
 319                 }
 320               }
 321               else {
 322                 CRM_Contact_Import_Parser_Contact::addToErrorMsg($dateLabels[$key], $errorMessage);
 323               }
 324               break;
 325
 326             case 'membership_type_id':
 327               if (!is_numeric($val)) {
 328                 unset($params['membership_type_id']);
 329                 $params['membership_type'] = $val;
 330               }
 331               break;
 332
 333             case 'status_id':
 334               // @todo - we can do this based on the presence of 'pseudoconstant' in the metadata rather than field specific.
 335               $params[$key] = $this->parsePseudoConstantField($val, $this->fieldMetadata[$key]);
 336               break;
 337
 338             case 'is_override':
 339               $params[$key] = CRM_Utils_String::strtobool($val);
 340               break;
 341           }
 342           if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
 343             if ($customFields[$customFieldID]['data_type'] == 'Date') {
 344               CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key);
 345               unset($params[$key]);
 346             }
 347             elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
 348               $params[$key] = CRM_Utils_String::strtoboolstr($val);
 349             }
 350           }
 351         }
 352       }
 353       //date-Format part ends
 354
 355       $formatValues = [];
 356       foreach ($params as $key => $field) {
 357         if ($field == NULL || $field === '') {
 358           continue;
 359         }
 360
 361         $formatValues[$key] = $field;
 362       }
 363
 364       //format params to meet api v2 requirements.
 365       //@todo find a way to test removing this formatting
 366       $formatError = $this->membership_format_params($formatValues, $formatted, TRUE);
 367
 368       if ($onDuplicate != CRM_Import_Parser::DUPLICATE_UPDATE) {
 369         $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($formatted,
 370           NULL,
 371           'Membership'
 372         );
 373       }
 374       else {
 375         //fix for CRM-2219 Update Membership
 376         // onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE
 377         if (!empty($formatted['is_override']) && empty($formatted['status_id'])) {
 378           array_unshift($values, 'Required parameter missing: Status');
 379           return CRM_Import_Parser::ERROR;
 380         }
 381
 382         if (!empty($formatValues['membership_id'])) {
 383           $dao = new CRM_Member_BAO_Membership();
 384           $dao->id = $formatValues['membership_id'];
 385           $dates = ['join_date', 'start_date', 'end_date'];
 386           foreach ($dates as $v) {
 387             if (empty($formatted[$v])) {
 388               $formatted[$v] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $formatValues['membership_id'], $v);
 389             }
 390           }
 391
 392           $formatted['custom'] = CRM_Core_BAO_CustomField::postProcess($formatted,
 393             $formatValues['membership_id'],
 394             'Membership'
 395           );
 396           if ($dao->find(TRUE)) {
 397             if (empty($params['line_item']) && !empty($formatted['membership_type_id'])) {
 398               CRM_Price_BAO_LineItem::getLineItemArray($formatted, NULL, 'membership', $formatted['membership_type_id']);
 399             }
 400
 401             // @todo stop passing $ids array (and put details in $formatted if required)
 402             $ids = [
 403               'membership' => $formatValues['membership_id'],
 404               'userId' => $session->get('userID'),
 405             ];
 406             $newMembership = CRM_Member_BAO_Membership::create($formatted, $ids, TRUE);
 407             if (civicrm_error($newMembership)) {
 408               array_unshift($values, $newMembership['is_error'] . ' for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
 409               return CRM_Import_Parser::ERROR;
 410             }
 411             else {
 412               $this->_newMemberships[] = $newMembership->id;
 413               return CRM_Import_Parser::VALID;
 414             }
 415           }
 416           else {
 417             array_unshift($values, 'Matching Membership record not found for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
 418             return CRM_Import_Parser::ERROR;
 419           }
 420         }
 421       }
 422
 423       //Format dates
 424       $startDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('start_date', $formatted), '%Y-%m-%d');
 425       $endDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('end_date', $formatted), '%Y-%m-%d');
 426       $joinDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('join_date', $formatted), '%Y-%m-%d');
 427
 428       if ($this->_contactIdIndex < 0) {
 429         $error = $this->checkContactDuplicate($formatValues);
 430
 431         if (CRM_Core_Error::isAPIError($error, CRM_Core_ERROR::DUPLICATE_CONTACT)) {
 432           $matchedIDs = explode(',', $error['error_message']['params'][0]);
 433           if (count($matchedIDs) > 1) {
 434             array_unshift($values, 'Multiple matching contact records detected for this row. The membership was not imported');
 435             return CRM_Import_Parser::ERROR;
 436           }
 437           else {
 438             $cid = $matchedIDs[0];
 439             $formatted['contact_id'] = $cid;
 440
 441             //fix for CRM-1924
 442             $calcDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($formatted['membership_type_id'],
 443               $joinDate,
 444               $startDate,
 445               $endDate
 446             );
 447             self::formattedDates($calcDates, $formatted);
 448
 449             //fix for CRM-3570, exclude the statuses those having is_admin = 1
 450             //now user can import is_admin if is override is true.
 451             $excludeIsAdmin = FALSE;
 452             if (empty($formatted['is_override'])) {
 453               $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
 454             }
 455             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
 456               $endDate,
 457               $joinDate,
 458               'today',
 459               $excludeIsAdmin,
 460               $formatted['membership_type_id'],
 461               $formatted
 462             );
 463
 464             if (empty($formatted['status_id'])) {
 465               $formatted['status_id'] = $calcStatus['id'];
 466             }
 467             elseif (empty($formatted['is_override'])) {
 468               if (empty($calcStatus)) {
 469                 array_unshift($values, 'Status in import row (' . $formatValues['status_id'] . ') does not match calculated status based on your configured Membership Status Rules. Record was not imported.');
 470                 return CRM_Import_Parser::ERROR;
 471               }
 472               elseif ($formatted['status_id'] != $calcStatus['id']) {
 473                 //Status Hold" is either NOT mapped or is FALSE
 474                 array_unshift($values, 'Status in import row (' . $formatValues['status_id'] . ') does not match calculated status based on your configured Membership Status Rules (' . $calcStatus['name'] . '). Record was not imported.');
 475                 return CRM_Import_Parser::ERROR;
 476               }
 477             }
 478
 479             $newMembership = civicrm_api3('membership', 'create', $formatted);
 480
 481             $this->_newMemberships[] = $newMembership['id'];
 482             return CRM_Import_Parser::VALID;
 483           }
 484         }
 485         else {
 486           // Using new Dedupe rule.
 487           $ruleParams = [
 488             'contact_type' => $this->_contactType,
 489             'used' => 'Unsupervised',
 490           ];
 491           $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 492           $disp = '';
 493
 494           foreach ($fieldsArray as $value) {
 495             if (array_key_exists(trim($value), $params)) {
 496               $paramValue = $params[trim($value)];
 497               if (is_array($paramValue)) {
 498                 $disp .= $params[trim($value)][0][trim($value)] . " ";
 499               }
 500               else {
 501                 $disp .= $params[trim($value)] . " ";
 502               }
 503             }
 504           }
 505
 506           if (!empty($params['external_identifier'])) {
 507             if ($disp) {
 508               $disp .= "AND {$params['external_identifier']}";
 509             }
 510             else {
 511               $disp = $params['external_identifier'];
 512             }
 513           }
 514
 515           array_unshift($values, 'No matching Contact found for (' . $disp . ')');
 516           return CRM_Import_Parser::ERROR;
 517         }
 518       }
 519       else {
 520         if (!empty($formatValues['external_identifier'])) {
 521           $checkCid = new CRM_Contact_DAO_Contact();
 522           $checkCid->external_identifier = $formatValues['external_identifier'];
 523           $checkCid->find(TRUE);
 524           if ($checkCid->id != $formatted['contact_id']) {
 525             array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
 526             return CRM_Import_Parser::ERROR;
 527           }
 528         }
 529
 530         //to calculate dates
 531         $calcDates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($formatted['membership_type_id'],
 532           $joinDate,
 533           $startDate,
 534           $endDate
 535         );
 536         self::formattedDates($calcDates, $formatted);
 537         //end of date calculation part
 538
 539         //fix for CRM-3570, exclude the statuses those having is_admin = 1
 540         //now user can import is_admin if is override is true.
 541         $excludeIsAdmin = FALSE;
 542         if (empty($formatted['is_override'])) {
 543           $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
 544         }
 545         $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($startDate,
 546           $endDate,
 547           $joinDate,
 548           'today',
 549           $excludeIsAdmin,
 550           $formatted['membership_type_id'],
 551           $formatted
 552         );
 553         if (empty($formatted['status_id'])) {
 554           $formatted['status_id'] = CRM_Utils_Array::value('id', $calcStatus);
 555         }
 556         elseif (empty($formatted['is_override'])) {
 557           if (empty($calcStatus)) {
 558             array_unshift($values, 'Status in import row (' . CRM_Utils_Array::value('status_id', $formatValues) . ') does not match calculated status based on your configured Membership Status Rules. Record was not imported.');
 559             return CRM_Import_Parser::ERROR;
 560           }
 561           elseif ($formatted['status_id'] != $calcStatus['id']) {
 562             //Status Hold" is either NOT mapped or is FALSE
 563             array_unshift($values, 'Status in import row (' . CRM_Utils_Array::value('status_id', $formatValues) . ') does not match calculated status based on your configured Membership Status Rules (' . $calcStatus['name'] . '). Record was not imported.');
 564             return CRM_Import_Parser::ERROR;
 565           }
 566         }
 567
 568         $newMembership = civicrm_api3('membership', 'create', $formatted);
 569
 570         $this->_newMemberships[] = $newMembership['id'];
 571         return CRM_Import_Parser::VALID;
 572       }
 573     }
 574     catch (Exception $e) {
 575       array_unshift($values, $e->getMessage());
 576       return CRM_Import_Parser::ERROR;
 577     }
 578   }
 579
 580   /**
 581    * Get the array of successfully imported membership id's
 582    *
 583    * @return array
 584    */
 585   public function &getImportedMemberships() {
 586     return $this->_newMemberships;
 587   }
 588
 589   /**
 590    * The initializer code, called before the processing
 591    *
 592    * @return void
 593    */
 594   public function fini() {
 595   }
 596
 597   /**
 598    *  to calculate join, start and end dates
 599    *
 600    * @param array $calcDates
 601    *   Array of dates returned by getDatesForMembershipType().
 602    *
 603    * @param $formatted
 604    *
 605    */
 606   public function formattedDates($calcDates, &$formatted) {
 607     $dates = [
 608       'join_date',
 609       'start_date',
 610       'end_date',
 611     ];
 612
 613     foreach ($dates as $d) {
 614       if (isset($formatted[$d]) &&
 615         !CRM_Utils_System::isNull($formatted[$d])
 616       ) {
 617         $formatted[$d] = CRM_Utils_Date::isoToMysql($formatted[$d]);
 618       }
 619       elseif (isset($calcDates[$d])) {
 620         $formatted[$d] = CRM_Utils_Date::isoToMysql($calcDates[$d]);
 621       }
 622     }
 623   }
 624
 625   /**
 626    * @deprecated - this function formats params according to v2 standards but
 627    * need to be sure about the impact of not calling it so retaining on the import class
 628    * take the input parameter list as specified in the data model and
 629    * convert it into the same format that we use in QF and BAO object
 630    *
 631    * @param array $params
 632    *   Associative array of property name/value.
 633    *                             pairs to insert in new contact.
 634    * @param array $values
 635    *   The reformatted properties that we can use internally.
 636    *
 637    * @param array|bool $create Is the formatted Values array going to
 638    *                             be used for CRM_Member_BAO_Membership:create()
 639    *
 640    * @throws Exception
 641    * @return array|error
 642    */
 643   public function membership_format_params($params, &$values, $create = FALSE) {
 644     require_once 'api/v3/utils.php';
 645     $fields = CRM_Member_DAO_Membership::fields();
 646     _civicrm_api3_store_values($fields, $params, $values);
 647
 648     $customFields = CRM_Core_BAO_CustomField::getFields('Membership');
 649
 650     foreach ($params as $key => $value) {
 651       // ignore empty values or empty arrays etc
 652       if (CRM_Utils_System::isNull($value)) {
 653         continue;
 654       }
 655
 656       //Handling Custom Data
 657       if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
 658         $values[$key] = $value;
 659         $type = $customFields[$customFieldID]['html_type'];
 660         if ($type == 'CheckBox' || $type == 'Multi-Select') {
 661           $mulValues = explode(',', $value);
 662           $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
 663           $values[$key] = [];
 664           foreach ($mulValues as $v1) {
 665             foreach ($customOption as $customValueID => $customLabel) {
 666               $customValue = $customLabel['value'];
 667               if ((strtolower($customLabel['label']) == strtolower(trim($v1))) ||
 668                 (strtolower($customValue) == strtolower(trim($v1)))
 669               ) {
 670                 if ($type == 'CheckBox') {
 671                   $values[$key][$customValue] = 1;
 672                 }
 673                 else {
 674                   $values[$key][] = $customValue;
 675                 }
 676               }
 677             }
 678           }
 679         }
 680       }
 681
 682       switch ($key) {
 683         case 'membership_contact_id':
 684           if (!CRM_Utils_Rule::integer($value)) {
 685             throw new Exception("contact_id not valid: $value");
 686           }
 687           $dao = new CRM_Core_DAO();
 688           $qParams = [];
 689           $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
 690             $qParams
 691           );
 692           if (!$svq) {
 693             throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
 694           }
 695           $values['contact_id'] = $values['membership_contact_id'];
 696           unset($values['membership_contact_id']);
 697           break;
 698
 699         case 'membership_type_id':
 700           if (!CRM_Utils_Array::value($value, CRM_Member_PseudoConstant::membershipType())) {
 701             throw new Exception('Invalid Membership Type Id');
 702           }
 703           $values[$key] = $value;
 704           break;
 705
 706         case 'membership_type':
 707           $membershipTypeId = CRM_Utils_Array::key(ucfirst($value),
 708             CRM_Member_PseudoConstant::membershipType()
 709           );
 710           if ($membershipTypeId) {
 711             if (!empty($values['membership_type_id']) &&
 712               $membershipTypeId != $values['membership_type_id']
 713             ) {
 714               throw new Exception('Mismatched membership Type and Membership Type Id');
 715             }
 716           }
 717           else {
 718             throw new Exception('Invalid Membership Type');
 719           }
 720           $values['membership_type_id'] = $membershipTypeId;
 721           break;
 722
 723         default:
 724           break;
 725       }
 726     }
 727
 728     _civicrm_api3_custom_format_params($params, $values, 'Membership');
 729
 730     if ($create) {
 731       // CRM_Member_BAO_Membership::create() handles membership_start_date,
 732       // membership_end_date and membership_source. So, if $values contains
 733       // membership_start_date, membership_end_date  or membership_source,
 734       // convert it to start_date, end_date or source
 735       $changes = [
 736         'membership_start_date' => 'start_date',
 737         'membership_end_date' => 'end_date',
 738         'membership_source' => 'source',
 739       ];
 740
 741       foreach ($changes as $orgVal => $changeVal) {
 742         if (isset($values[$orgVal])) {
 743           $values[$changeVal] = $values[$orgVal];
 744           unset($values[$orgVal]);
 745         }
 746       }
 747     }
 748
 749     return NULL;
 750   }
 751
 752 }