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 * Details of the subscription (recurring contribution) to be altered.
108 protected $subscriptionDetails = [];
111 * Is the form being accessed by a front end user to update their own recurring.
115 protected $selfService;
118 * Explicitly declare the entity api name.
120 public function getDefaultEntity() {
121 return 'ContributionRecur';
125 * Explicitly declare the form context.
127 public function getDefaultContext() {
132 * Get the entity id being edited.
136 public function getEntityId() {
137 return $this->contributionRecurID
;
141 * Set variables up before form is built.
143 * @throws \CRM_Core_Exception
145 public function preProcess() {
146 $this->setAction(CRM_Core_Action
::UPDATE
);
147 $this->_mid
= CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE);
148 $this->_crid
= CRM_Utils_Request
::retrieve('crid', 'Integer', $this, FALSE);
149 $this->contributionRecurID
= $this->_crid
;
150 $this->_coid
= CRM_Utils_Request
::retrieve('coid', 'Integer', $this, FALSE);
151 $this->setSubscriptionDetails();
152 $this->setPaymentProcessor();
153 if ($this->getSubscriptionContactID()) {
154 $this->set('cid', $this->getSubscriptionContactID());
159 * Set the payment processor object up.
161 * This is a function that needs to be better consolidated between the inheriting forms
162 * but this is good choice of function to call.
164 protected function setPaymentProcessor() {
166 $this->_paymentProcessor
= CRM_Contribute_BAO_ContributionRecur
::getPaymentProcessor($this->contributionRecurID
);
167 if (!$this->_paymentProcessor
) {
168 CRM_Core_Error
::statusBounce(ts('There is no valid processor for this subscription so it cannot be updated'));
170 $this->_paymentProcessorObj
= $this->_paymentProcessor
['object'];
172 elseif ($this->_mid
) {
173 $this->_paymentProcessorObj
= CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($this->_mid
, 'membership', 'obj');
174 $this->_paymentProcessor
= $this->_paymentProcessorObj
->getPaymentProcessor();
179 * Set the subscription details on the form.
181 protected function setSubscriptionDetails() {
182 if ($this->contributionRecurID
) {
183 $this->subscriptionDetails
= $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_crid
);
185 elseif ($this->_coid
) {
186 $this->subscriptionDetails
= $this->_subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_coid
, 'contribution');
188 elseif ($this->_mid
) {
189 $this->subscriptionDetails
= CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($this->_mid
, 'membership');
191 // This is being set temporarily - we should eventually just use the getter fn.
192 $this->_subscriptionDetails
= $this->subscriptionDetails
;
196 * Get details for the recurring contribution being altered.
200 public function getSubscriptionDetails() {
201 return $this->subscriptionDetails
;
205 * Get the contact ID for the subscription.
209 protected function getSubscriptionContactID() {
210 $sub = $this->getSubscriptionDetails();
211 return isset($sub->contact_id
) ?
$sub->contact_id
: FALSE;
215 * Is this being used by a front end user to update their own recurring.
219 protected function isSelfService() {
220 if (!is_null($this->selfService
)) {
221 return $this->selfService
;
223 $this->selfService
= FALSE;
224 if (!CRM_Core_Permission
::check('edit contributions')) {
225 if ($this->_subscriptionDetails
->contact_id
!= $this->getContactID()) {
226 CRM_Core_Error
::statusBounce(ts('You do not have permission to cancel this recurring contribution.'));
228 $this->selfService
= TRUE;
230 return $this->selfService
;