CRM/Member/Form.php

   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
  18 /**
  19  * Base class for offline membership / membership type / membership renewal and membership status forms
  20  *
  21  */
  22 class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment {
  23
  24   use CRM_Core_Form_EntityFormTrait;
  25
  26   /**
  27    * Membership Type ID
  28    * @var int
  29    */
  30   protected $_memType;
  31
  32   /**
  33    * Array of from email ids
  34    * @var array
  35    */
  36   protected $_fromEmails = [];
  37
  38   /**
  39    * Details of all enabled membership types.
  40    *
  41    * @var array
  42    */
  43   protected $allMembershipTypeDetails = [];
  44
  45   /**
  46    * Array of membership type IDs and whether they permit autorenewal.
  47    *
  48    * @var array
  49    */
  50   protected $membershipTypeRenewalStatus = [];
  51
  52   /**
  53    * Price set ID configured for the form.
  54    *
  55    * @var int
  56    */
  57   public $_priceSetId;
  58
  59   /**
  60    * Price set details as an array.
  61    *
  62    * @var array
  63    */
  64   public $_priceSet;
  65
  66   /**
  67    * The order being processed.
  68    *
  69    * @var \CRM_Financial_BAO_Order
  70    */
  71   protected $order;
  72
  73   /**
  74    * This string is the used for passing to the buildAmount hook.
  75    *
  76    * @var string
  77    */
  78   protected $formContext = 'membership';
  79
  80   /**
  81    * @return string
  82    */
  83   public function getFormContext(): string {
  84     return $this->formContext;
  85   }
  86
  87   /**
  88    * Explicitly declare the entity api name.
  89    */
  90   public function getDefaultEntity() {
  91     return 'Membership';
  92   }
  93
  94   /**
  95    * @var array
  96    */
  97   protected $statusMessage = [];
  98
  99   /**
 100    * Add to the status message.
 101    *
 102    * @param string $message
 103    */
 104   protected function addStatusMessage($message) {
 105     $this->statusMessage[] = $message;
 106   }
 107
 108   /**
 109    * Get the status message.
 110    *
 111    * @return string
 112    */
 113   protected function getStatusMessage() {
 114     return implode(' ', $this->statusMessage);
 115   }
 116
 117   /**
 118    * Values submitted to the form, processed along the way.
 119    *
 120    * @var array
 121    */
 122   protected $_params = [];
 123
 124   /**
 125    * Fields for the entity to be assigned to the template.
 126    *
 127    * Fields may have keys
 128    *  - name (required to show in tpl from the array)
 129    *  - description (optional, will appear below the field)
 130    *  - not-auto-addable - this class will not attempt to add the field using addField.
 131    *    (this will be automatically set if the field does not have html in it's metadata
 132    *    or is not a core field on the form's entity).
 133    *  - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']]
 134    *  - template - use a field specific template to render this field
 135    *  - required
 136    *  - is_freeze (field should be frozen).
 137    *
 138    * @var array
 139    */
 140   protected $entityFields = [];
 141
 142   public function preProcess() {
 143     // Check for edit permission.
 144     if (!CRM_Core_Permission::checkActionPermission('CiviMember', $this->_action)) {
 145       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 146     }
 147     if (!CRM_Member_BAO_Membership::statusAvailabilty()) {
 148       // all possible statuses are disabled - redirect back to contact form
 149       CRM_Core_Error::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
 150     }
 151
 152     parent::preProcess();
 153     $params = [];
 154     $params['context'] = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'membership');
 155     $params['id'] = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 156     $params['mode'] = CRM_Utils_Request::retrieve('mode', 'Alphanumeric', $this);
 157
 158     $this->setContextVariables($params);
 159
 160     $this->assign('context', $this->_context);
 161     $this->assign('membershipMode', $this->_mode);
 162     $this->allMembershipTypeDetails = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, [], TRUE);
 163     foreach ($this->allMembershipTypeDetails as $index => $membershipType) {
 164       if ($membershipType['auto_renew']) {
 165         $this->_recurMembershipTypes[$index] = $membershipType;
 166         $this->membershipTypeRenewalStatus[$index] = $membershipType['auto_renew'];
 167       }
 168     }
 169   }
 170
 171   /**
 172    * Set default values for the form. MobileProvider that in edit/view mode
 173    * the default values are retrieved from the database
 174    *
 175    *
 176    * @return array
 177    *   defaults
 178    */
 179   public function setDefaultValues() {
 180     $defaults = [];
 181     if (isset($this->_id)) {
 182       $params = ['id' => $this->_id];
 183       CRM_Member_BAO_Membership::retrieve($params, $defaults);
 184       if (isset($defaults['minimum_fee'])) {
 185         $defaults['minimum_fee'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['minimum_fee']);
 186       }
 187
 188       if (isset($defaults['status'])) {
 189         $this->assign('membershipStatus', $defaults['status']);
 190       }
 191
 192       if (!empty($defaults['is_override'])) {
 193         $defaults['is_override'] = CRM_Member_StatusOverrideTypes::PERMANENT;
 194       }
 195       if (!empty($defaults['status_override_end_date'])) {
 196         $defaults['is_override'] = CRM_Member_StatusOverrideTypes::UNTIL_DATE;
 197       }
 198     }
 199
 200     if ($this->_action & CRM_Core_Action::ADD) {
 201       $defaults['is_active'] = 1;
 202     }
 203
 204     if (isset($defaults['member_of_contact_id']) &&
 205       $defaults['member_of_contact_id']
 206     ) {
 207       $defaults['member_org'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 208         $defaults['member_of_contact_id'], 'display_name'
 209       );
 210     }
 211     if (!empty($defaults['membership_type_id'])) {
 212       $this->_memType = $defaults['membership_type_id'];
 213     }
 214     if (is_numeric($this->_memType)) {
 215       $defaults['membership_type_id'] = [];
 216       $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 217         $this->_memType,
 218         'member_of_contact_id',
 219         'id'
 220       );
 221       $defaults['membership_type_id'][1] = $this->_memType;
 222     }
 223     else {
 224       $defaults['membership_type_id'] = $this->_memType;
 225     }
 226     return $defaults;
 227   }
 228
 229   /**
 230    * Build the form object.
 231    */
 232   public function buildQuickForm() {
 233     $this->assignSalesTaxMetadataToTemplate();
 234
 235     $this->addPaymentProcessorSelect(TRUE, FALSE, TRUE);
 236     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, $this->getDefaultPaymentInstrumentId());
 237     $this->assign('recurProcessor', json_encode($this->_recurPaymentProcessors));
 238     // Build the form for auto renew. This is displayed when in credit card mode or update mode.
 239     // The reason for showing it in update mode is not that clear.
 240     if ($this->_mode || ($this->_action & CRM_Core_Action::UPDATE)) {
 241       if (!empty($this->_recurPaymentProcessors)) {
 242         $this->assign('allowAutoRenew', TRUE);
 243       }
 244
 245       $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
 246         NULL, ['onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );"]
 247       );
 248       if ($this->_action & CRM_Core_Action::UPDATE) {
 249         $autoRenewElement->freeze();
 250       }
 251
 252       $this->addElement('checkbox',
 253         'auto_renew',
 254         ts('Membership renewed automatically')
 255       );
 256
 257     }
 258     $this->assign('autoRenewOptions', json_encode($this->membershipTypeRenewalStatus));
 259
 260     if ($this->_action & CRM_Core_Action::RENEW) {
 261       $this->addButtons([
 262         [
 263           'type' => 'upload',
 264           'name' => ts('Renew'),
 265           'isDefault' => TRUE,
 266         ],
 267         [
 268           'type' => 'cancel',
 269           'name' => ts('Cancel'),
 270         ],
 271       ]);
 272     }
 273     elseif ($this->_action & CRM_Core_Action::DELETE) {
 274       $this->addButtons([
 275         [
 276           'type' => 'next',
 277           'name' => ts('Delete'),
 278           'isDefault' => TRUE,
 279         ],
 280         [
 281           'type' => 'cancel',
 282           'name' => ts('Cancel'),
 283         ],
 284       ]);
 285     }
 286     else {
 287       $this->addButtons([
 288         [
 289           'type' => 'upload',
 290           'name' => ts('Save'),
 291           'isDefault' => TRUE,
 292         ],
 293         [
 294           'type' => 'upload',
 295           'name' => ts('Save and New'),
 296           'subName' => 'new',
 297         ],
 298         [
 299           'type' => 'cancel',
 300           'name' => ts('Cancel'),
 301         ],
 302       ]);
 303     }
 304   }
 305
 306   /**
 307    * Extract values from the contact create boxes on the form and assign appropriately  to
 308    *
 309    *  - $this->_contributorEmail,
 310    *  - $this->_memberEmail &
 311    *  - $this->_contributionName
 312    *  - $this->_memberName
 313    *  - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
 314    *  - $this->_contributorContactId - id of the contributor
 315    *  - $this->_receiptContactId
 316    *
 317    * If the member & contributor are the same then the values will be the same. But if different people paid
 318    * then they weill differ
 319    *
 320    * @param array $formValues
 321    *   values from form. The important values we are looking for are.
 322    *  - contact_id
 323    *  - soft_credit_contact_id
 324    */
 325   public function storeContactFields($formValues) {
 326     // in a 'standalone form' (contact id not in the url) the contact will be in the form values
 327     if (!empty($formValues['contact_id'])) {
 328       $this->_contactID = $formValues['contact_id'];
 329     }
 330
 331     [$this->_memberDisplayName, $this->_memberEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 332     $this->_contributorContactID = $this->getContributionContactID();
 333     //CRM-10375 Where the payer differs to the member the payer should get the email.
 334     // here we store details in order to do that
 335     if (!empty($formValues['soft_credit_contact_id'])) {
 336       $this->_receiptContactId = $formValues['soft_credit_contact_id'];
 337       [$this->_contributorDisplayName, $this->_contributorEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contributorContactID);
 338     }
 339     else {
 340       $this->_receiptContactId = $this->_contactID;
 341       $this->_contributorDisplayName = $this->_memberDisplayName;
 342       $this->_contributorEmail = $this->_memberEmail;
 343     }
 344   }
 345
 346   /**
 347    * Get the contact id for the contribution.
 348    *
 349    * @return int
 350    */
 351   protected function getContributionContactID(): int {
 352     return (int) ($this->getSubmittedValue('soft_credit_contact_id') ?: $this->getSubmittedValue('contact_id'));
 353   }
 354
 355   /**
 356    * Get the contact id for the contribution.
 357    *
 358    * @return int
 359    */
 360   protected function getMembershipContactID(): int {
 361     // It's not clear that $this->_contactID *could* be set outside
 362     // tests when contact_id is not submitted - so this fallback
 363     // is precautionary in order to be similar to past behaviour.
 364     return (int) ($this->getSubmittedValue('contact_id') ?: $this->_contactID);
 365   }
 366
 367   /**
 368    * Set variables in a way that can be accessed from different places.
 369    *
 370    * This is part of refactoring for unit testability on the submit function.
 371    *
 372    * @param array $params
 373    */
 374   protected function setContextVariables($params) {
 375     $variables = [
 376       'action' => '_action',
 377       'context' => '_context',
 378       'id' => '_id',
 379       'cid' => '_contactID',
 380       'mode' => '_mode',
 381     ];
 382     foreach ($variables as $paramKey => $classVar) {
 383       if (isset($params[$paramKey]) && !isset($this->$classVar)) {
 384         $this->$classVar = $params[$paramKey];
 385       }
 386     }
 387
 388     if ($this->_id) {
 389       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 390       $this->_membershipIDs[] = $this->_id;
 391     }
 392     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 393   }
 394
 395   /**
 396    * Create a recurring contribution record.
 397    *
 398    * @param array $contributionRecurParams
 399    *
 400    * @param int $membershipTypeID
 401    *
 402    * @return array
 403    * @throws \CiviCRM_API3_Exception
 404    */
 405   protected function processRecurringContribution($contributionRecurParams, $membershipTypeID) {
 406
 407     $mapping = [
 408       'frequency_interval' => 'duration_interval',
 409       'frequency_unit' => 'duration_unit',
 410     ];
 411     $membershipType = civicrm_api3('MembershipType', 'getsingle', [
 412       'id' => $membershipTypeID,
 413       'return' => $mapping,
 414     ]);
 415
 416     $returnParams = ['is_recur' => TRUE];
 417     foreach ($mapping as $recurringFieldName => $membershipTypeFieldName) {
 418       $contributionRecurParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 419       $returnParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 420     }
 421
 422     $contributionRecur = civicrm_api3('ContributionRecur', 'create', $contributionRecurParams);
 423     $returnParams['contributionRecurID'] = $contributionRecur['id'];
 424     return $returnParams;
 425   }
 426
 427   /**
 428    * Ensure price parameters are set.
 429    *
 430    * If they are not set it means a quick config option has been chosen so we
 431    * fill them in here to make the two flows the same. They look like 'price_2' => 2 etc.
 432    *
 433    * @param array $formValues
 434    */
 435   protected function ensurePriceParamsAreSet(&$formValues) {
 436     foreach ($formValues as $key => $value) {
 437       if ((substr($key, 0, 6) == 'price_') && is_numeric(substr($key, 6))) {
 438         return;
 439       }
 440     }
 441     $priceFields = CRM_Member_BAO_Membership::setQuickConfigMembershipParameters(
 442       $formValues['membership_type_id'][0],
 443       $formValues['membership_type_id'][1],
 444       CRM_Utils_Array::value('total_amount', $formValues),
 445       $this->_priceSetId
 446     );
 447     $formValues = array_merge($formValues, $priceFields['price_fields']);
 448   }
 449
 450   /**
 451    * Get the details for the selected price set.
 452    *
 453    * @param array $params
 454    *   Parameters submitted to the form.
 455    *
 456    * @return array
 457    */
 458   protected function getPriceSetDetails(array $params): ?array {
 459     $priceSetID = $params['price_set_id'] ?? NULL;
 460     if ($priceSetID) {
 461       return CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
 462     }
 463     else {
 464       $priceSet = CRM_Price_BAO_PriceSet::getDefaultPriceSet('membership');
 465       $priceSet = reset($priceSet);
 466       return CRM_Price_BAO_PriceSet::getSetDetail($priceSet['setID']);
 467     }
 468   }
 469
 470   /**
 471    * Get the selected price set id.
 472    *
 473    * @param array $params
 474    *   Parameters submitted to the form.
 475    *
 476    * @return int
 477    */
 478   protected function getPriceSetID(array $params): int {
 479     $priceSetID = $params['price_set_id'] ?? NULL;
 480     if (!$priceSetID) {
 481       $priceSetDetails = $this->getPriceSetDetails($params);
 482       return (int) key($priceSetDetails);
 483     }
 484     return (int) $priceSetID;
 485   }
 486
 487   /**
 488    * Store parameters relating to price sets.
 489    *
 490    * @param array $formValues
 491    *
 492    * @return array
 493    * @throws \API_Exception
 494    */
 495   protected function setPriceSetParameters(array $formValues): array {
 496     // process price set and get total amount and line items.
 497     $this->_priceSetId = $this->getPriceSetID($formValues);
 498     $this->ensurePriceParamsAreSet($formValues);
 499     $priceSetDetails = $this->getPriceSetDetails($formValues);
 500     $this->_priceSet = $priceSetDetails[$this->_priceSetId];
 501     $this->order = new CRM_Financial_BAO_Order();
 502     $this->order->setForm($this);
 503     $this->order->setPriceSelectionFromUnfilteredInput($formValues);
 504     if (isset($formValues['total_amount'])) {
 505       $this->order->setOverrideTotalAmount((float) $formValues['total_amount']);
 506     }
 507     $this->order->setOverrideFinancialTypeID((int) $formValues['financial_type_id']);
 508     return $formValues;
 509   }
 510
 511   /**
 512    * Wrapper function for unit tests.
 513    *
 514    * @param array $formValues
 515    */
 516   public function testSubmit(array $formValues = []): void {
 517     if (empty($formValues)) {
 518       // If getForm is used these will be set - this is now
 519       // preferred.
 520       $formValues = $this->controller->exportValues($this->_name);
 521     }
 522     $this->exportedValues = $formValues;
 523     $this->setContextVariables($formValues);
 524     $this->_memType = !empty($formValues['membership_type_id']) ? $formValues['membership_type_id'][1] : NULL;
 525     $this->_params = $formValues;
 526     $this->submit();
 527   }
 528
 529   /**
 530    * Get order related params.
 531    *
 532    * In practice these are contribution params but later they cann be used with the Order api.
 533    *
 534    * @return array
 535    *
 536    * @throws \CiviCRM_API3_Exception
 537    */
 538   protected function getOrderParams(): array {
 539     return [
 540       'lineItems' => [$this->_priceSetId => $this->order->getLineItems()],
 541       // This is one of those weird & wonderful legacy params we aim to get rid of.
 542       'processPriceSet' => TRUE,
 543       'tax_amount' => $this->order->getTotalTaxAmount(),
 544     ];
 545   }
 546
 547   /**
 548    * Get the currency in use.
 549    *
 550    * This just defaults to getting the default currency
 551    * as other currencies are not supported on the membership
 552    * forms at the moment.
 553    *
 554    * @param array $submittedValues
 555    *
 556    * @return string
 557    */
 558   public function getCurrency($submittedValues = []): string {
 559     return CRM_Core_Config::singleton()->defaultCurrency;
 560   }
 561
 562   /**
 563    * Get the relevant payment instrument id.
 564    *
 565    * @return int
 566    */
 567   protected function getPaymentInstrumentID(): int {
 568     return (int) $this->getSubmittedValue('payment_instrument_id') ?: $this->_paymentProcessor['object']->getPaymentInstrumentID();
 569   }
 570
 571   /**
 572    * Get the last 4 numbers of the card.
 573    *
 574    * @return int|null
 575    */
 576   protected function getPanTruncation(): ?int {
 577     $card = $this->getSubmittedValue('credit_card_number');
 578     return $card ? (int) substr($card, -4) : NULL;
 579   }
 580
 581   /**
 582    * Get the card_type_id.
 583    *
 584    * This value is the integer representing the option value for
 585    * the credit card type (visa, mastercard). It is stored as part of the
 586    * payment record in civicrm_financial_trxn.
 587    *
 588    * @return int|null
 589    */
 590   protected function getCardTypeID(): ?int {
 591     return CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->getSubmittedValue('credit_card_type'));
 592   }
 593
 594 }