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
{
39 use CRM_Core_Form_EntityFormTrait
;
46 protected $_coid = NULL;
49 * Contribution Recur ID.
53 protected $_crid = NULL;
56 * The recurring contribution id, used when editing the recurring contribution.
58 * For historical reasons this duplicates _crid & since the name is more meaningful
59 * we should probably deprecate $_crid.
63 protected $contributionRecurID = NULL;
70 protected $_mid = NULL;
73 * Payment processor object.
75 * @var \CRM_Core_Payment
77 protected $_paymentProcessorObj = NULL;
80 * Current payment processor.
82 * This includes a copy of the object in 'object' key for legacy reasons.
86 public $_paymentProcessor = [];
89 * Fields for the entity to be assigned to the template.
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
101 protected $entityFields = [];
104 * Explicitly declare the entity api name.
106 public function getDefaultEntity() {
107 return 'ContributionRecur';
111 * Explicitly declare the form context.
113 public function getDefaultContext() {
118 * Get the entity id being edited.
122 public function getEntityId() {
123 return $this->contributionRecurID
;
127 * Set variables up before form is built.
129 public function preProcess() {
130 $this->setAction(CRM_Core_Action
::UPDATE
);
131 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
132 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
133 $this->contributionRecurID
= $this->_crid
;
134 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
135 $this->setPaymentProcessor();
139 * Set the payment processor object up.
141 * This is a function that needs to be better consolidated between the inheriting forms
142 * but this is good choice of function to call.
144 protected function setPaymentProcessor() {
146 $this->_paymentProcessor
= CRM_Contribute_BAO_ContributionRecur
::getPaymentProcessor($this->contributionRecurID
);
147 if (!$this->_paymentProcessor
) {
148 CRM_Core_Error
::statusBounce(ts('There is no valid processor for this subscription so it cannot be updated'));
150 $this->_paymentProcessorObj
= $this->_paymentProcessor
['object'];