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