Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 useful, 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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | ||
29 | /** | |
c28e1768 | 30 | * This api exposes CiviCRM contribution pages. |
6a488035 TO |
31 | * |
32 | * @package CiviCRM_APIv3 | |
6a488035 TO |
33 | */ |
34 | ||
35 | /** | |
244bbdd8 | 36 | * Create or update a ContributionPage. |
6a488035 | 37 | * |
cf470720 | 38 | * @param array $params |
2e66abf8 | 39 | * Array per getfields metadata. |
6a488035 | 40 | * |
a6c01b45 | 41 | * @return array |
72b3a70c | 42 | * api result array |
6a488035 TO |
43 | */ |
44 | function civicrm_api3_contribution_page_create($params) { | |
ddaf2161 | 45 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionPage'); |
10a3c9b9 EM |
46 | CRM_Contribute_PseudoConstant::flush('contributionPageAll'); |
47 | CRM_Contribute_PseudoConstant::flush('contributionPageActive'); | |
48 | return $result; | |
6a488035 | 49 | } |
11e09c59 TO |
50 | |
51 | /** | |
0aa0303c EM |
52 | * Adjust Metadata for Create action. |
53 | * | |
54 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 55 | * |
cf470720 | 56 | * @param array $params |
2e66abf8 | 57 | * Array per getfields metadata. |
6a488035 TO |
58 | */ |
59 | function _civicrm_api3_contribution_page_create_spec(&$params) { | |
60 | $params['financial_type_id']['api.required'] = 1; | |
cf8f0fff | 61 | $params['payment_processor']['api.aliases'] = ['payment_processor_id']; |
9fed6619 | 62 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
63 | } |
64 | ||
65 | /** | |
244bbdd8 | 66 | * Returns array of ContributionPage(s) matching a set of one or more group properties. |
6a488035 | 67 | * |
cf470720 | 68 | * @param array $params |
2e66abf8 | 69 | * Array per getfields metadata. |
6a488035 | 70 | * |
a6c01b45 | 71 | * @return array |
72b3a70c | 72 | * API Result array Array of matching contribution_pages |
6a488035 TO |
73 | */ |
74 | function civicrm_api3_contribution_page_get($params) { | |
75 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
76 | } | |
77 | ||
78 | /** | |
244bbdd8 | 79 | * Delete an existing ContributionPage. |
6a488035 | 80 | * |
244bbdd8 | 81 | * This method is used to delete any existing ContributionPage given its id. |
6a488035 | 82 | * |
cf470720 | 83 | * @param array $params |
2e66abf8 | 84 | * Array per getfields metadata. |
6a488035 | 85 | * |
a6c01b45 | 86 | * @return array |
72b3a70c | 87 | * API result Array |
6a488035 TO |
88 | */ |
89 | function civicrm_api3_contribution_page_delete($params) { | |
90 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
91 | } | |
be26f3e0 EM |
92 | |
93 | /** | |
244bbdd8 | 94 | * Submit a ContributionPage. |
be26f3e0 | 95 | * |
cf470720 | 96 | * @param array $params |
2e66abf8 | 97 | * Array per getfields metadata. |
be26f3e0 | 98 | * |
a6c01b45 | 99 | * @return array |
72b3a70c | 100 | * API result array |
be26f3e0 EM |
101 | */ |
102 | function civicrm_api3_contribution_page_submit($params) { | |
103 | $result = CRM_Contribute_Form_Contribution_Confirm::submit($params); | |
244bbdd8 | 104 | return civicrm_api3_create_success($result, $params, 'ContributionPage', 'submit'); |
be26f3e0 | 105 | } |
b233e1b4 | 106 | |
c59e7960 | 107 | /** |
108 | * Validate ContributionPage submission parameters. | |
109 | * | |
110 | * @param array $params | |
111 | * Array per getfields metadata. | |
112 | * | |
113 | * @return array | |
114 | * API result array | |
115 | */ | |
116 | function civicrm_api3_contribution_page_validate($params) { | |
dbc654ec | 117 | // If we are calling this as a result of a POST action (e.g validating a form submission before first getting payment |
118 | // authorization from a payment processor like Paypal checkout) the lack of a qfKey will not result in a valid | |
119 | // one being generated so we generate one first. | |
a1a01300 | 120 | $originalRequest = $_REQUEST; |
dbc654ec | 121 | $qfKey = CRM_Utils_Array::value('qfKey', $_REQUEST); |
122 | if (!$qfKey) { | |
123 | $_REQUEST['qfKey'] = CRM_Core_Key::get('CRM_Core_Controller', TRUE); | |
124 | } | |
c59e7960 | 125 | $form = new CRM_Contribute_Form_Contribution_Main(); |
126 | $form->controller = new CRM_Core_Controller(); | |
127 | $form->set('id', $params['id']); | |
128 | $form->preProcess(); | |
129 | $errors = CRM_Contribute_Form_Contribution_Main::formRule($params, [], $form); | |
130 | if ($errors === TRUE) { | |
131 | $errors = []; | |
132 | } | |
a1a01300 | 133 | $_REQUEST = $originalRequest; |
c59e7960 | 134 | return civicrm_api3_create_success($errors, $params, 'ContributionPage', 'validate'); |
135 | } | |
b233e1b4 | 136 | |
dbc654ec | 137 | /** |
138 | * Metadata for validate action. | |
139 | * | |
140 | * @param array $params | |
141 | */ | |
142 | function _civicrm_api3_contribution_page_validate_spec(&$params) { | |
143 | $params['id'] = [ | |
144 | 'title' => ts('Contribution Page ID'), | |
145 | 'api.required' => TRUE, | |
146 | 'type' => CRM_Utils_Type::T_INT, | |
147 | ]; | |
148 | } | |
149 | ||
b233e1b4 CW |
150 | /** |
151 | * Set default getlist parameters. | |
152 | * | |
153 | * @see _civicrm_api3_generic_getlist_defaults | |
154 | * | |
155 | * @param array $request | |
156 | * | |
157 | * @return array | |
158 | */ | |
159 | function _civicrm_api3_contribution_page_getlist_defaults(&$request) { | |
cf8f0fff CW |
160 | return [ |
161 | 'description_field' => [ | |
b233e1b4 | 162 | 'intro_text', |
cf8f0fff CW |
163 | ], |
164 | 'params' => [ | |
b233e1b4 | 165 | 'is_active' => 1, |
cf8f0fff CW |
166 | ], |
167 | ]; | |
b233e1b4 | 168 | } |