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 | |
379d6cd7 |
39 | use CRM_Core_Form_EntityFormTrait; |
40 | |
ca809bb6 |
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 | |
1f17c8ef |
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 | |
71e680bd |
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 | |
379d6cd7 |
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 | |
ca809bb6 |
96 | /** |
97 | * Explicitly declare the entity api name. |
98 | */ |
99 | public function getDefaultEntity() { |
100 | return 'ContributionRecur'; |
101 | } |
102 | |
103 | /** |
104 | * Explicitly declare the form context. |
105 | */ |
106 | public function getDefaultContext() { |
107 | return 'create'; |
108 | } |
109 | |
1f17c8ef |
110 | /** |
111 | * Set variables up before form is built. |
112 | */ |
113 | public function preProcess() { |
379d6cd7 |
114 | $this->setAction(CRM_Core_Action::UPDATE); |
1f17c8ef |
115 | $this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE); |
116 | $this->_crid = CRM_Utils_Request::retrieve('crid', 'Integer', $this, FALSE); |
117 | $this->contributionRecurID = $this->_crid; |
118 | $this->_coid = CRM_Utils_Request::retrieve('coid', 'Integer', $this, FALSE); |
71e680bd |
119 | $this->setPaymentProcessor(); |
120 | } |
121 | |
122 | /** |
123 | * Set the payment processor object up. |
124 | * |
125 | * This is a function that needs to be better consolidated between the inheriting forms |
126 | * but this is good choice of function to call. |
127 | */ |
128 | protected function setPaymentProcessor() { |
129 | if ($this->_crid) { |
130 | $this->_paymentProcessor = CRM_Contribute_BAO_ContributionRecur::getPaymentProcessor($this->contributionRecurID); |
131 | if (!$this->_paymentProcessor) { |
132 | CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be updated')); |
133 | } |
134 | $this->_paymentProcessorObj = $this->_paymentProcessor['object']; |
135 | } |
1f17c8ef |
136 | } |
137 | |
ca809bb6 |
138 | } |