CRM/Member/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * Base class for offline membership / membership type / membership renewal and membership status forms
  36  *
  37  */
  38 class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment {
  39
  40   /**
  41    * The id of the object being edited / created
  42    *
  43    * @var int
  44    */
  45   public $_id;
  46
  47   /**
  48    * Membership Type ID
  49    * @var
  50    */
  51   protected $_memType;
  52
  53   /**
  54    * Array of from email ids
  55    * @var array
  56    */
  57   protected $_fromEmails = array();
  58
  59   /**
  60    * Details of all enabled membership types.
  61    *
  62    * @var array
  63    */
  64   protected $allMembershipTypeDetails = array();
  65
  66   /**
  67    * Array of membership type IDs and whether they permit autorenewal.
  68    *
  69    * @var array
  70    */
  71   protected $membershipTypeRenewalStatus = array();
  72
  73   /**
  74    * Price set ID configured for the form.
  75    *
  76    * @var int
  77    */
  78   public $_priceSetId;
  79
  80   /**
  81    * Price set details as an array.
  82    *
  83    * @var array
  84    */
  85   public $_priceSet;
  86
  87   /**
  88    * Values submitted to the form, processed along the way.
  89    *
  90    * @var array
  91    */
  92   protected $_params = array();
  93
  94   public function preProcess() {
  95     // Check for edit permission.
  96     if (!CRM_Core_Permission::checkActionPermission('CiviMember', $this->_action)) {
  97       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
  98     }
  99     if (!CRM_Member_BAO_Membership::statusAvailabilty()) {
 100       // all possible statuses are disabled - redirect back to contact form
 101       CRM_Core_Error::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
 102     }
 103
 104     parent::preProcess();
 105     $params = array();
 106     $params['context'] = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'membership');
 107     $params['id'] = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 108     $params['mode'] = CRM_Utils_Request::retrieve('mode', 'String', $this);
 109
 110     $this->setContextVariables($params);
 111
 112     $this->assign('context', $this->_context);
 113     $this->assign('membershipMode', $this->_mode);
 114     $this->allMembershipTypeDetails = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, array(), TRUE);
 115     foreach ($this->allMembershipTypeDetails as $index => $membershipType) {
 116       if ($membershipType['auto_renew']) {
 117         $this->_recurMembershipTypes[$index] = $membershipType;
 118         $this->membershipTypeRenewalStatus[$index] = $membershipType['auto_renew'];
 119       }
 120     }
 121   }
 122
 123   /**
 124    * Set default values for the form. MobileProvider that in edit/view mode
 125    * the default values are retrieved from the database
 126    *
 127    *
 128    * @return array
 129    *   defaults
 130    */
 131   public function setDefaultValues() {
 132     $defaults = array();
 133     if (isset($this->_id)) {
 134       $params = array('id' => $this->_id);
 135       CRM_Member_BAO_Membership::retrieve($params, $defaults);
 136       if (isset($defaults['minimum_fee'])) {
 137         $defaults['minimum_fee'] = CRM_Utils_Money::format($defaults['minimum_fee'], NULL, '%a');
 138       }
 139
 140       if (isset($defaults['status'])) {
 141         $this->assign('membershipStatus', $defaults['status']);
 142       }
 143     }
 144
 145     if ($this->_action & CRM_Core_Action::ADD) {
 146       $defaults['is_active'] = 1;
 147     }
 148
 149     if (isset($defaults['member_of_contact_id']) &&
 150       $defaults['member_of_contact_id']
 151     ) {
 152       $defaults['member_org'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 153         $defaults['member_of_contact_id'], 'display_name'
 154       );
 155     }
 156     if (!empty($defaults['membership_type_id'])) {
 157       $this->_memType = $defaults['membership_type_id'];
 158     }
 159     if (is_numeric($this->_memType)) {
 160       $defaults['membership_type_id'] = array();
 161       $defaults['membership_type_id'][0] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 162         $this->_memType,
 163         'member_of_contact_id',
 164         'id'
 165       );
 166       $defaults['membership_type_id'][1] = $this->_memType;
 167     }
 168     else {
 169       $defaults['membership_type_id'] = $this->_memType;
 170     }
 171     return $defaults;
 172   }
 173
 174   /**
 175    * Build the form object.
 176    */
 177   public function buildQuickForm() {
 178
 179     $this->addPaymentProcessorSelect(TRUE, FALSE, TRUE);
 180     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, $this->getDefaultPaymentInstrumentId());
 181     // Build the form for auto renew. This is displayed when in credit card mode or update mode.
 182     // The reason for showing it in update mode is not that clear.
 183     if ($this->_mode || ($this->_action & CRM_Core_Action::UPDATE)) {
 184       if (!empty($this->_recurPaymentProcessors)) {
 185         $this->assign('allowAutoRenew', TRUE);
 186       }
 187
 188       $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
 189         NULL, array('onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );")
 190       );
 191       if ($this->_action & CRM_Core_Action::UPDATE) {
 192         $autoRenewElement->freeze();
 193       }
 194
 195       $this->assign('recurProcessor', json_encode($this->_recurPaymentProcessors));
 196       $this->addElement('checkbox',
 197         'auto_renew',
 198         ts('Membership renewed automatically')
 199       );
 200
 201     }
 202     $this->assign('autoRenewOptions', json_encode($this->membershipTypeRenewalStatus));
 203
 204     if ($this->_action & CRM_Core_Action::RENEW) {
 205       $this->addButtons(array(
 206         array(
 207           'type' => 'upload',
 208           'name' => ts('Renew'),
 209           'isDefault' => TRUE,
 210         ),
 211         array(
 212           'type' => 'cancel',
 213           'name' => ts('Cancel'),
 214         ),
 215       ));
 216     }
 217     elseif ($this->_action & CRM_Core_Action::DELETE) {
 218       $this->addButtons(array(
 219         array(
 220           'type' => 'next',
 221           'name' => ts('Delete'),
 222           'isDefault' => TRUE,
 223         ),
 224         array(
 225           'type' => 'cancel',
 226           'name' => ts('Cancel'),
 227         ),
 228       ));
 229     }
 230     else {
 231       $this->addButtons(array(
 232         array(
 233           'type' => 'upload',
 234           'name' => ts('Save'),
 235           'isDefault' => TRUE,
 236         ),
 237         array(
 238           'type' => 'upload',
 239           'name' => ts('Save and New'),
 240           'subName' => 'new',
 241         ),
 242         array(
 243           'type' => 'cancel',
 244           'name' => ts('Cancel'),
 245         ),
 246       ));
 247     }
 248   }
 249
 250   /**
 251    * Extract values from the contact create boxes on the form and assign appropriately  to
 252    *
 253    *  - $this->_contributorEmail,
 254    *  - $this->_memberEmail &
 255    *  - $this->_contributionName
 256    *  - $this->_memberName
 257    *  - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
 258    *  - $this->_contributorContactId - id of the contributor
 259    *  - $this->_receiptContactId
 260    *
 261    * If the member & contributor are the same then the values will be the same. But if different people paid
 262    * then they weill differ
 263    *
 264    * @param array $formValues
 265    *   values from form. The important values we are looking for are.
 266    *  - contact_id
 267    *  - soft_credit_contact_id
 268    */
 269   public function storeContactFields($formValues) {
 270     // in a 'standalone form' (contact id not in the url) the contact will be in the form values
 271     if (!empty($formValues['contact_id'])) {
 272       $this->_contactID = $formValues['contact_id'];
 273     }
 274
 275     list($this->_memberDisplayName,
 276       $this->_memberEmail
 277       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 278
 279     //CRM-10375 Where the payer differs to the member the payer should get the email.
 280     // here we store details in order to do that
 281     if (!empty($formValues['soft_credit_contact_id'])) {
 282       $this->_receiptContactId = $this->_contributorContactID = $formValues['soft_credit_contact_id'];
 283       list($this->_contributorDisplayName,
 284         $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contributorContactID);
 285     }
 286     else {
 287       $this->_receiptContactId = $this->_contributorContactID = $this->_contactID;
 288       $this->_contributorDisplayName = $this->_memberDisplayName;
 289       $this->_contributorEmail = $this->_memberEmail;
 290     }
 291   }
 292
 293   /**
 294    * Set variables in a way that can be accessed from different places.
 295    *
 296    * This is part of refactoring for unit testability on the submit function.
 297    *
 298    * @param array $params
 299    */
 300   protected function setContextVariables($params) {
 301     $variables = array(
 302       'action' => '_action',
 303       'context' => '_context',
 304       'id' => '_id',
 305       'cid' => '_contactID',
 306       'mode' => '_mode',
 307     );
 308     foreach ($variables as $paramKey => $classVar) {
 309       if (isset($params[$paramKey]) && !isset($this->$classVar)) {
 310         $this->$classVar = $params[$paramKey];
 311       }
 312     }
 313
 314     if ($this->_id) {
 315       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 316       $this->_membershipIDs[] = $this->_id;
 317     }
 318     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 319   }
 320
 321   /**
 322    * Create a recurring contribution record.
 323    *
 324    * Recurring contribution parameters are set explicitly rather than merging paymentParams because it's hard
 325    * to know the downstream impacts if we keep passing around the same array.
 326    *
 327    * @param $paymentParams
 328    *
 329    * @return array
 330    * @throws \CiviCRM_API3_Exception
 331    */
 332   protected function processRecurringContribution($paymentParams) {
 333     $membershipID = $paymentParams['membership_type_id'][1];
 334     $contributionRecurParams = array(
 335       'contact_id' => $paymentParams['contactID'],
 336       'amount' => $paymentParams['total_amount'],
 337       'contribution_status_id' => 'Pending',
 338       'payment_processor_id' => $paymentParams['payment_processor_id'],
 339       'campaign_id' => $paymentParams['campaign_id'],
 340       'financial_type_id' => $paymentParams['financial_type_id'],
 341       'is_email_receipt' => $paymentParams['is_email_receipt'],
 342       'payment_instrument_id' => $paymentParams['payment_instrument_id'],
 343       'invoice_id' => $paymentParams['invoice_id'],
 344     );
 345
 346     $mapping = array(
 347       'frequency_interval' => 'duration_interval',
 348       'frequency_unit' => 'duration_unit',
 349     );
 350     $membershipType = civicrm_api3('MembershipType', 'getsingle', array(
 351       'id' => $membershipID,
 352       'return' => $mapping,
 353     ));
 354
 355     $returnParams = array('is_recur' => TRUE);
 356     foreach ($mapping as $recurringFieldName => $membershipTypeFieldName) {
 357       $contributionRecurParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 358       $returnParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
 359     }
 360
 361     $contributionRecur = civicrm_api3('ContributionRecur', 'create', $contributionRecurParams);
 362     $returnParams['contributionRecurID'] = $contributionRecur['id'];
 363     return $returnParams;
 364   }
 365
 366   /**
 367    * Ensure price parameters are set.
 368    *
 369    * If they are not set it means a quick config option has been chosen so we
 370    * fill them in here to make the two flows the same. They look like 'price_2' => 2 etc.
 371    *
 372    * @param array $formValues
 373    */
 374   protected function ensurePriceParamsAreSet(&$formValues) {
 375     foreach ($formValues as $key => $value) {
 376       if ((substr($key, 0, 6) == 'price_') && is_numeric(substr($key, 6))) {
 377         return;
 378       }
 379     }
 380     $priceFields = CRM_Member_BAO_Membership::setQuickConfigMembershipParameters(
 381       $formValues['membership_type_id'][0],
 382       $formValues['membership_type_id'][1],
 383       CRM_Utils_Array::value('total_amount', $formValues),
 384       $this->_priceSetId
 385     );
 386     $formValues = array_merge($formValues, $priceFields['price_fields']);
 387   }
 388
 389   /**
 390    * Get the details for the selected price set.
 391    *
 392    * @param array $params
 393    *   Parameters submitted to the form.
 394    *
 395    * @return array
 396    */
 397   protected static function getPriceSetDetails($params) {
 398     $priceSetID = CRM_Utils_Array::value('price_set_id', $params);
 399     if ($priceSetID) {
 400       return CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
 401     }
 402     else {
 403       $priceSet = CRM_Price_BAO_PriceSet::getDefaultPriceSet('membership');
 404       $priceSet = reset($priceSet);
 405       return CRM_Price_BAO_PriceSet::getSetDetail($priceSet['setID']);
 406     }
 407   }
 408
 409   /**
 410    * Get the selected price set id.
 411    *
 412    * @param array $params
 413    *   Parameters submitted to the form.
 414    *
 415    * @return int
 416    */
 417   protected static function getPriceSetID($params) {
 418     $priceSetID = CRM_Utils_Array::value('price_set_id', $params);
 419     if (!$priceSetID) {
 420       $priceSetDetails = self::getPriceSetDetails($params);
 421       return key($priceSetDetails);
 422     }
 423     return $priceSetID;
 424   }
 425
 426   /**
 427    * Store parameters relating to price sets.
 428    *
 429    * @param array $formValues
 430    *
 431    * @return array
 432    */
 433   protected function setPriceSetParameters($formValues) {
 434     $this->_priceSetId = self::getPriceSetID($formValues);
 435     $priceSetDetails = self::getPriceSetDetails($formValues);
 436     $this->_priceSet = $priceSetDetails[$this->_priceSetId];
 437     // process price set and get total amount and line items.
 438     $this->ensurePriceParamsAreSet($formValues);
 439     return $formValues;
 440   }
 441
 442   /**
 443    * Wrapper function for unit tests.
 444    *
 445    * @param array $formValues
 446    */
 447   public function testSubmit($formValues) {
 448     $this->setContextVariables($formValues);
 449     $this->_memType = $formValues['membership_type_id'][1];
 450     $this->_params = $formValues;
 451     $this->submit();
 452   }
 453
 454 }