CRM/Member/Form.php

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