ca809bb6 |
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 | /** |
40 | * @var int Contribution ID |
41 | */ |
42 | protected $_coid = NULL; |
43 | |
44 | /** |
45 | * @var int Contribution Recur ID |
46 | */ |
47 | protected $_crid = NULL; |
48 | |
1f17c8ef |
49 | /** |
50 | * The recurring contribution id, used when editing the recurring contribution. |
51 | * |
52 | * For historical reasons this duplicates _crid & since the name is more meaningful |
53 | * we should probably deprecate $_crid. |
54 | * |
55 | * @var int |
56 | */ |
57 | protected $contributionRecurID = NULL; |
58 | |
59 | /** |
60 | * @var int Membership ID |
61 | */ |
62 | protected $_mid = NULL; |
63 | |
71e680bd |
64 | /** |
65 | * Payment processor object. |
66 | * |
67 | * @var \CRM_Core_Payment |
68 | */ |
69 | protected $_paymentProcessorObj = NULL; |
70 | |
71 | /** |
72 | * @var array |
73 | * |
74 | * Current payment processor including a copy of the object in 'object' key for |
75 | * legacy reasons. |
76 | */ |
77 | public $_paymentProcessor = []; |
78 | |
ca809bb6 |
79 | /** |
80 | * Explicitly declare the entity api name. |
81 | */ |
82 | public function getDefaultEntity() { |
83 | return 'ContributionRecur'; |
84 | } |
85 | |
86 | /** |
87 | * Explicitly declare the form context. |
88 | */ |
89 | public function getDefaultContext() { |
90 | return 'create'; |
91 | } |
92 | |
1f17c8ef |
93 | /** |
94 | * Set variables up before form is built. |
95 | */ |
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); |
71e680bd |
101 | $this->setPaymentProcessor(); |
102 | } |
103 | |
104 | /** |
105 | * Set the payment processor object up. |
106 | * |
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. |
109 | */ |
110 | protected function setPaymentProcessor() { |
111 | if ($this->_crid) { |
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')); |
115 | } |
116 | $this->_paymentProcessorObj = $this->_paymentProcessor['object']; |
117 | } |
1f17c8ef |
118 | } |
119 | |
ca809bb6 |
120 | } |