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->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
 163     $this->allMembershipTypeDetails = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, [], TRUE);
 164     foreach ($this->allMembershipTypeDetails as $index => $membershipType) {
 165       if ($membershipType['auto_renew']) {
 166         $this->_recurMembershipTypes[$index] = $membershipType;
 167         $this->membershipTypeRenewalStatus[$index] = $membershipType['auto_renew'];
 168       }
 169     }
 170   }
 171
 172   /**
 173    * Set default values for the form. MobileProvider that in edit/view mode
 174    * the default values are retrieved from the database
 175    *
 176    *
 177    * @return array
 178    *   defaults
 179    */
 180   public function setDefaultValues() {
 181     $defaults = [];
 182     if (isset($this->_id)) {
 183       $params = ['id' => $this->_id];
 184       CRM_Member_BAO_Membership::retrieve($params, $defaults);
 185       if (isset($defaults['minimum_fee'])) {
 186         $defaults['minimum_fee'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['minimum_fee']);
 187       }
 188
 189       if (isset($defaults['status'])) {
 190         $this->assign('membershipStatus', $defaults['status']);
 191       }
 192
 193       if (!empty($defaults['is_override'])) {
 194         $defaults['is_override'] = CRM_Member_StatusOverrideTypes::PERMANENT;
 195       }
 196       if (!empty($defaults['status_override_end_date'])) {
 197         $defaults['is_override'] = CRM_Member_StatusOverrideTypes::UNTIL_DATE;
 198       }
 199     }
 200
 201     if ($this->_action & CRM_Core_Action::ADD) {
 202       $defaults['is_active'] = 1;
 203     }
 204
 205     if (isset($defaults['member_of_contact_id']) &&
 206       $defaults['member_of_contact_id']
 207     ) {
 208       $defaults['member_org'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 209         $defaults['member_of_contact_id'], 'display_name'
 210       );
 211     }
 212     if (!empty($defaults['membership_type_id'])) {
 213       $this->_memType = $defaults['membership_type_id'];
 214     }
 215     if (is_numeric($this->_memType)) {
 216       $defaults['membership_type_id'] = [];
 217       $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 218         $this->_memType,
 219         'member_of_contact_id',
 220         'id'
 221       );
 222       $defaults['membership_type_id'][1] = $this->_memType;
 223     }
 224     else {
 225       $defaults['membership_type_id'] = $this->_memType;
 226     }
 227     return $defaults;
 228   }
 229
 230   /**
 231    * Build the form object.
 232    */
 233   public function buildQuickForm() {
 234     $this->assignSalesTaxMetadataToTemplate();
 235
 236     $this->addPaymentProcessorSelect(TRUE, FALSE, TRUE);
 237     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, $this->getDefaultPaymentInstrumentId());
 238     $this->assign('recurProcessor', json_encode($this->_recurPaymentProcessors));
 239     // Build the form for auto renew. This is displayed when in credit card mode or update mode.
 240     // The reason for showing it in update mode is not that clear.
 241     $this->assign('allowAutoRenew', $this->_mode && !empty($this->_recurPaymentProcessors));
 242     if ($this->_mode || ($this->_action & CRM_Core_Action::UPDATE)) {
 243
 244       $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
 245         NULL, ['onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );"]
 246       );
 247       if ($this->_action & CRM_Core_Action::UPDATE) {
 248         $autoRenewElement->freeze();
 249       }
 250
 251       $this->addElement('checkbox',
 252         'auto_renew',
 253         ts('Membership renewed automatically')
 254       );
 255
 256     }
 257     $this->assign('autoRenewOptions', json_encode($this->membershipTypeRenewalStatus));
 258
 259     if ($this->_action & CRM_Core_Action::RENEW) {
 260       $this->addButtons([
 261         [
 262           'type' => 'upload',
 263           'name' => ts('Renew'),
 264           'isDefault' => TRUE,
 265         ],
 266         [
 267           'type' => 'cancel',
 268           'name' => ts('Cancel'),
 269         ],
 270       ]);
 271     }
 272     elseif ($this->_action & CRM_Core_Action::DELETE) {
 273       $this->addButtons([
 274         [
 275           'type' => 'next',
 276           'name' => ts('Delete'),
 277           'isDefault' => TRUE,
 278         ],
 279         [
 280           'type' => 'cancel',
 281           'name' => ts('Cancel'),
 282         ],
 283       ]);
 284     }
 285     else {
 286       $this->addButtons([
 287         [
 288           'type' => 'upload',
 289           'name' => ts('Save'),
 290           'isDefault' => TRUE,
 291         ],
 292         [
 293           'type' => 'upload',
 294           'name' => ts('Save and New'),
 295           'subName' => 'new',
 296         ],
 297         [
 298           'type' => 'cancel',
 299           'name' => ts('Cancel'),
 300         ],
 301       ]);
 302     }
 303   }
 304
 305   /**
 306    * Extract values from the contact create boxes on the form and assign appropriately  to
 307    *
 308    *  - $this->_contributorEmail,
 309    *  - $this->_memberEmail &
 310    *  - $this->_contributionName
 311    *  - $this->_memberName
 312    *  - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
 313    *  - $this->_contributorContactId - id of the contributor
 314    *  - $this->_receiptContactId
 315    *
 316    * If the member & contributor are the same then the values will be the same. But if different people paid
 317    * then they weill differ
 318    *
 319    * @param array $formValues
 320    *   values from form. The important values we are looking for are.
 321    *  - contact_id
 322    *  - soft_credit_contact_id
 323    */
 324   public function storeContactFields($formValues) {
 325     // in a 'standalone form' (contact id not in the url) the contact will be in the form values
 326     if (!empty($formValues['contact_id'])) {
 327       $this->_contactID = $formValues['contact_id'];
 328     }
 329
 330     [$this->_memberDisplayName, $this->_memberEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 331     $this->_contributorContactID = $this->getContributionContactID();
 332     //CRM-10375 Where the payer differs to the member the payer should get the email.
 333     // here we store details in order to do that
 334     if (!empty($formValues['soft_credit_contact_id'])) {
 335       $this->_receiptContactId = $formValues['soft_credit_contact_id'];
 336       [$this->_contributorDisplayName, $this->_contributorEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contributorContactID);
 337     }
 338     else {
 339       $this->_receiptContactId = $this->_contactID;
 340       $this->_contributorDisplayName = $this->_memberDisplayName;
 341       $this->_contributorEmail = $this->_memberEmail;
 342     }
 343   }
 344
 345   /**
 346    * Get the contact id for the contribution.
 347    *
 348    * @return int
 349    */
 350   protected function getContributionContactID(): int {
 351     return (int) ($this->getSubmittedValue('soft_credit_contact_id') ?: $this->getSubmittedValue('contact_id'));
 352   }
 353
 354   /**
 355    * Get the contact id for the contribution.
 356    *
 357    * @return int
 358    */
 359   protected function getMembershipContactID(): int {
 360     // It's not clear that $this->_contactID *could* be set outside
 361     // tests when contact_id is not submitted - so this fallback
 362     // is precautionary in order to be similar to past behaviour.
 363     return (int) ($this->getSubmittedValue('contact_id') ?: $this->_contactID);
 364   }
 365
 366   /**
 367    * Set variables in a way that can be accessed from different places.
 368    *
 369    * This is part of refactoring for unit testability on the submit function.
 370    *
 371    * @param array $params
 372    */
 373   protected function setContextVariables($params) {
 374     $variables = [
 375       'action' => '_action',
 376       'context' => '_context',
 377       'id' => '_id',
 378       'cid' => '_contactID',
 379       'mode' => '_mode',
 380     ];
 381     foreach ($variables as $paramKey => $classVar) {
 382       if (isset($params[$paramKey]) && !isset($this->$classVar)) {
 383         $this->$classVar = $params[$paramKey];
 384       }
 385     }
 386
 387     if ($this->_id) {
 388       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 389       $this->_membershipIDs[] = $this->_id;
 390     }
 391     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 392   }
 393
 394   /**
 395    * Create a recurring contribution record.
 396    *
 397    * @param array $contributionRecurParams
 398    *
 399    * @param int $membershipTypeID
 400    *
 401    * @return array
 402    * @throws \CiviCRM_API3_Exception
 403    */
 404   protected function processRecurringContribution($contributionRecurParams, $membershipTypeID) {
 405
 406     $mapping = [
 407       'frequency_interval' => 'duration_interval',
 408       'frequency_unit' => 'duration_unit',
 409     ];
 410     $membershipType = civicrm_api3('MembershipType', 'getsingle', [
 411       'id' => $membershipTypeID,
 412       'return' => $mapping,
 413     ]);
 414
 415     $returnParams = ['is_recur' => TRUE];
 416     foreach ($mapping as $recurringFieldName => $membershipTypeFieldName) {
 417       $contributionRecurParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 418       $returnParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 419     }
 420
 421     $contributionRecur = civicrm_api3('ContributionRecur', 'create', $contributionRecurParams);
 422     $returnParams['contributionRecurID'] = $contributionRecur['id'];
 423     return $returnParams;
 424   }
 425
 426   /**
 427    * Ensure price parameters are set.
 428    *
 429    * If they are not set it means a quick config option has been chosen so we
 430    * fill them in here to make the two flows the same. They look like 'price_2' => 2 etc.
 431    *
 432    * @param array $formValues
 433    */
 434   protected function ensurePriceParamsAreSet(&$formValues) {
 435     foreach ($formValues as $key => $value) {
 436       if ((substr($key, 0, 6) == 'price_') && is_numeric(substr($key, 6))) {
 437         return;
 438       }
 439     }
 440     $priceFields = CRM_Member_BAO_Membership::setQuickConfigMembershipParameters(
 441       $formValues['membership_type_id'][0],
 442       $formValues['membership_type_id'][1],
 443       CRM_Utils_Array::value('total_amount', $formValues),
 444       $this->_priceSetId
 445     );
 446     $formValues = array_merge($formValues, $priceFields['price_fields']);
 447   }
 448
 449   /**
 450    * Get the details for the selected price set.
 451    *
 452    * @param array $params
 453    *   Parameters submitted to the form.
 454    *
 455    * @return array
 456    */
 457   protected function getPriceSetDetails(array $params): ?array {
 458     $priceSetID = $params['price_set_id'] ?? NULL;
 459     if ($priceSetID) {
 460       return CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
 461     }
 462     else {
 463       $priceSet = CRM_Price_BAO_PriceSet::getDefaultPriceSet('membership');
 464       $priceSet = reset($priceSet);
 465       return CRM_Price_BAO_PriceSet::getSetDetail($priceSet['setID']);
 466     }
 467   }
 468
 469   /**
 470    * Get the selected price set id.
 471    *
 472    * @param array $params
 473    *   Parameters submitted to the form.
 474    *
 475    * @return int
 476    */
 477   protected function getPriceSetID(array $params): int {
 478     $priceSetID = $params['price_set_id'] ?? NULL;
 479     if (!$priceSetID) {
 480       $priceSetDetails = $this->getPriceSetDetails($params);
 481       return (int) key($priceSetDetails);
 482     }
 483     return (int) $priceSetID;
 484   }
 485
 486   /**
 487    * Store parameters relating to price sets.
 488    *
 489    * @param array $formValues
 490    *
 491    * @return array
 492    * @throws \API_Exception
 493    */
 494   protected function setPriceSetParameters(array $formValues): array {
 495     // process price set and get total amount and line items.
 496     $this->_priceSetId = $this->getPriceSetID($formValues);
 497     $this->ensurePriceParamsAreSet($formValues);
 498     $priceSetDetails = $this->getPriceSetDetails($formValues);
 499     $this->_priceSet = $priceSetDetails[$this->_priceSetId];
 500     $this->order = new CRM_Financial_BAO_Order();
 501     $this->order->setForm($this);
 502     $this->order->setPriceSelectionFromUnfilteredInput($formValues);
 503     if (isset($formValues['total_amount'])) {
 504       $this->order->setOverrideTotalAmount((float) $formValues['total_amount']);
 505     }
 506     $this->order->setOverrideFinancialTypeID((int) $formValues['financial_type_id']);
 507     return $formValues;
 508   }
 509
 510   /**
 511    * Wrapper function for unit tests.
 512    *
 513    * @param array $formValues
 514    */
 515   public function testSubmit(array $formValues = []): void {
 516     if (empty($formValues)) {
 517       // If getForm is used these will be set - this is now
 518       // preferred.
 519       $formValues = $this->controller->exportValues($this->_name);
 520     }
 521     $this->exportedValues = $formValues;
 522     $this->setContextVariables($formValues);
 523     $this->_memType = !empty($formValues['membership_type_id']) ? $formValues['membership_type_id'][1] : NULL;
 524     $this->_params = $formValues;
 525     $this->submit();
 526   }
 527
 528   /**
 529    * Get order related params.
 530    *
 531    * In practice these are contribution params but later they cann be used with the Order api.
 532    *
 533    * @return array
 534    *
 535    * @throws \CiviCRM_API3_Exception
 536    */
 537   protected function getOrderParams(): array {
 538     return [
 539       'lineItems' => [$this->_priceSetId => $this->order->getLineItems()],
 540       // This is one of those weird & wonderful legacy params we aim to get rid of.
 541       'processPriceSet' => TRUE,
 542       'tax_amount' => $this->order->getTotalTaxAmount(),
 543     ];
 544   }
 545
 546   /**
 547    * Get the currency in use.
 548    *
 549    * This just defaults to getting the default currency
 550    * as other currencies are not supported on the membership
 551    * forms at the moment.
 552    *
 553    * @param array $submittedValues
 554    *
 555    * @return string
 556    */
 557   public function getCurrency($submittedValues = []): string {
 558     return CRM_Core_Config::singleton()->defaultCurrency;
 559   }
 560
 561   /**
 562    * Get the relevant payment instrument id.
 563    *
 564    * @return int
 565    */
 566   protected function getPaymentInstrumentID(): int {
 567     return (int) $this->getSubmittedValue('payment_instrument_id') ?: $this->_paymentProcessor['object']->getPaymentInstrumentID();
 568   }
 569
 570   /**
 571    * Get the last 4 numbers of the card.
 572    *
 573    * @return int|null
 574    */
 575   protected function getPanTruncation(): ?int {
 576     $card = $this->getSubmittedValue('credit_card_number');
 577     return $card ? (int) substr($card, -4) : NULL;
 578   }
 579
 580   /**
 581    * Get the card_type_id.
 582    *
 583    * This value is the integer representing the option value for
 584    * the credit card type (visa, mastercard). It is stored as part of the
 585    * payment record in civicrm_financial_trxn.
 586    *
 587    * @return int|null
 588    */
 589   protected function getCardTypeID(): ?int {
 590     return CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->getSubmittedValue('credit_card_type'));
 591   }
 592
 593 }