CRM/Member/Form.php

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