3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * Shared parent class for recurring contribution forms.
37 class CRM_Contribute_Form_ContributionRecur
extends CRM_Core_Form
{
40 * @var int Contribution ID
42 protected $_coid = NULL;
45 * @var int Contribution Recur ID
47 protected $_crid = NULL;
50 * The recurring contribution id, used when editing the recurring contribution.
52 * For historical reasons this duplicates _crid & since the name is more meaningful
53 * we should probably deprecate $_crid.
57 protected $contributionRecurID = NULL;
60 * @var int Membership ID
62 protected $_mid = NULL;
65 * Payment processor object.
67 * @var \CRM_Core_Payment
69 protected $_paymentProcessorObj = NULL;
74 * Current payment processor including a copy of the object in 'object' key for
77 public $_paymentProcessor = [];
80 * Explicitly declare the entity api name.
82 public function getDefaultEntity() {
83 return 'ContributionRecur';
87 * Explicitly declare the form context.
89 public function getDefaultContext() {
94 * Set variables up before form is built.
96 public function preProcess() {
97 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
98 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
99 $this->contributionRecurID
= $this->_crid
;
100 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
101 $this->setPaymentProcessor();
105 * Set the payment processor object up.
107 * This is a function that needs to be better consolidated between the inheriting forms
108 * but this is good choice of function to call.
110 protected function setPaymentProcessor() {
112 $this->_paymentProcessor
= CRM_Contribute_BAO_ContributionRecur
::getPaymentProcessor($this->contributionRecurID
);
113 if (!$this->_paymentProcessor
) {
114 CRM_Core_Error
::statusBounce(ts('There is no valid processor for this subscription so it cannot be updated'));
116 $this->_paymentProcessorObj
= $this->_paymentProcessor
['object'];