CRM/Contribute/Form/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 usefusul, 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-2019
  32  */
  33
  34 /**
  35  * Shared parent class for recurring contribution forms.
  36  */
  37 class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form {
  38
  39   use CRM_Core_Form_EntityFormTrait;
  40
  41   /**
  42    * Contribution ID.
  43    *
  44    * @var int
  45    */
  46   protected $_coid = NULL;
  47
  48   /**
  49    * Contribution Recur ID.
  50    *
  51    * @var int
  52    */
  53   protected $_crid = NULL;
  54
  55   /**
  56    * The recurring contribution id, used when editing the recurring contribution.
  57    *
  58    * For historical reasons this duplicates _crid & since the name is more meaningful
  59    * we should probably deprecate $_crid.
  60    *
  61    * @var int
  62    */
  63   protected $contributionRecurID = NULL;
  64
  65   /**
  66    * Membership ID.
  67    *
  68    * @var int
  69    */
  70   protected $_mid = NULL;
  71
  72   /**
  73    * Payment processor object.
  74    *
  75    * @var \CRM_Core_Payment
  76    */
  77   protected $_paymentProcessorObj = NULL;
  78
  79   /**
  80    * Current payment processor.
  81    *
  82    * This includes a copy of the object in 'object' key for legacy reasons.
  83    *
  84    * @var array
  85    */
  86   public $_paymentProcessor = [];
  87
  88   /**
  89    * Fields for the entity to be assigned to the template.
  90    *
  91    * Fields may have keys
  92    *  - name (required to show in tpl from the array)
  93    *  - description (optional, will appear below the field)
  94    *  - not-auto-addable - this class will not attempt to add the field using addField.
  95    *    (this will be automatically set if the field does not have html in it's metadata
  96    *    or is not a core field on the form's entity).
  97    *  - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']]
  98    *  - template - use a field specific template to render this field
  99    * @var array
 100    */
 101   protected $entityFields = [];
 102
 103   /**
 104    * Details of the subscription (recurring contribution) to be altered.
 105    *
 106    * @var array
 107    */
 108   protected $subscriptionDetails = [];
 109
 110   /**
 111    * Explicitly declare the entity api name.
 112    */
 113   public function getDefaultEntity() {
 114     return 'ContributionRecur';
 115   }
 116
 117   /**
 118    * Explicitly declare the form context.
 119    */
 120   public function getDefaultContext() {
 121     return 'create';
 122   }
 123
 124   /**
 125    * Get the entity id being edited.
 126    *
 127    * @return int|null
 128    */
 129   public function getEntityId() {
 130     return $this->contributionRecurID;
 131   }
 132
 133   /**
 134    * Set variables up before form is built.
 135    *
 136    * @throws \CRM_Core_Exception
 137    */
 138   public function preProcess() {
 139     $this->setAction(CRM_Core_Action::UPDATE);
 140     $this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE);
 141     $this->_crid = CRM_Utils_Request::retrieve('crid', 'Integer', $this, FALSE);
 142     $this->contributionRecurID = $this->_crid;
 143     $this->_coid = CRM_Utils_Request::retrieve('coid', 'Integer', $this, FALSE);
 144     $this->setSubscriptionDetails();
 145     $this->setPaymentProcessor();
 146     if ($this->getSubscriptionContactID()) {
 147       $this->set('cid', $this->getSubscriptionContactID());
 148     }
 149   }
 150
 151   /**
 152    * Set the payment processor object up.
 153    *
 154    * This is a function that needs to be better consolidated between the inheriting forms
 155    * but this is good choice of function to call.
 156    */
 157   protected function setPaymentProcessor() {
 158     if ($this->_crid) {
 159       $this->_paymentProcessor = CRM_Contribute_BAO_ContributionRecur::getPaymentProcessor($this->contributionRecurID);
 160       if (!$this->_paymentProcessor) {
 161         CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be updated'));
 162       }
 163       $this->_paymentProcessorObj = $this->_paymentProcessor['object'];
 164     }
 165   }
 166
 167   /**
 168    * Set the subscription details on the form.
 169    */
 170   protected function setSubscriptionDetails() {
 171     if ($this->contributionRecurID) {
 172       $this->subscriptionDetails = $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_crid);
 173     }
 174     elseif ($this->_coid) {
 175       $this->subscriptionDetails = $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_coid, 'contribution');
 176     }
 177   }
 178
 179   /**
 180    * Get details for the recurring contribution being altered.
 181    *
 182    * @return array
 183    */
 184   public function getSubscriptionDetails() {
 185     return $this->subscriptionDetails;
 186   }
 187
 188   /**
 189    * Get the contact ID for the subscription.
 190    *
 191    * @return int|false
 192    */
 193   protected function getSubscriptionContactID() {
 194     $sub = $this->getSubscriptionDetails();
 195     return isset($sub->contact_id) ? $sub->contact_id : FALSE;
 196   }
 197
 198 }