Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | /** | |
30 | * File for the CiviCRM APIv3 group functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_ContributionPage | |
34 | * @copyright CiviCRM LLC (c) 20042012 | |
35 | */ | |
36 | ||
37 | /** | |
2e66abf8 | 38 | * Create or update a contribution_page. |
6a488035 | 39 | * |
cf470720 | 40 | * @param array $params |
2e66abf8 | 41 | * Array per getfields metadata. |
6a488035 | 42 | * |
a6c01b45 | 43 | * @return array |
72b3a70c | 44 | * api result array |
6a488035 TO |
45 | */ |
46 | function civicrm_api3_contribution_page_create($params) { | |
10a3c9b9 EM |
47 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
48 | CRM_Contribute_PseudoConstant::flush('contributionPageAll'); | |
49 | CRM_Contribute_PseudoConstant::flush('contributionPageActive'); | |
50 | return $result; | |
6a488035 | 51 | } |
11e09c59 TO |
52 | |
53 | /** | |
0aa0303c EM |
54 | * Adjust Metadata for Create action. |
55 | * | |
56 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 57 | * |
cf470720 | 58 | * @param array $params |
2e66abf8 | 59 | * Array per getfields metadata. |
6a488035 TO |
60 | */ |
61 | function _civicrm_api3_contribution_page_create_spec(&$params) { | |
62 | $params['financial_type_id']['api.required'] = 1; | |
16c0ec8d | 63 | $params['payment_processor']['api.aliases'] = array('payment_processor_id'); |
9fed6619 | 64 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
65 | } |
66 | ||
67 | /** | |
2e66abf8 | 68 | * Returns array of contribution_pages matching a set of one or more group properties. |
6a488035 | 69 | * |
cf470720 | 70 | * @param array $params |
2e66abf8 | 71 | * Array per getfields metadata. |
6a488035 | 72 | * |
a6c01b45 | 73 | * @return array |
72b3a70c | 74 | * API Result array Array of matching contribution_pages |
6a488035 TO |
75 | */ |
76 | function civicrm_api3_contribution_page_get($params) { | |
77 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } | |
79 | ||
80 | /** | |
2e66abf8 | 81 | * Delete an existing contribution_page. |
6a488035 TO |
82 | * |
83 | * This method is used to delete any existing contribution_page. id of the group | |
84 | * to be deleted is required field in $params array | |
85 | * | |
cf470720 | 86 | * @param array $params |
2e66abf8 | 87 | * Array per getfields metadata. |
6a488035 | 88 | * |
a6c01b45 | 89 | * @return array |
72b3a70c | 90 | * API result Array |
6a488035 TO |
91 | */ |
92 | function civicrm_api3_contribution_page_delete($params) { | |
93 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } | |
be26f3e0 EM |
95 | |
96 | /** | |
2e66abf8 | 97 | * Submit a contribution_page. |
be26f3e0 | 98 | * |
cf470720 | 99 | * @param array $params |
2e66abf8 | 100 | * Array per getfields metadata. |
be26f3e0 | 101 | * |
a6c01b45 | 102 | * @return array |
72b3a70c | 103 | * API result array |
be26f3e0 EM |
104 | */ |
105 | function civicrm_api3_contribution_page_submit($params) { | |
106 | $result = CRM_Contribute_Form_Contribution_Confirm::submit($params); | |
107 | return civicrm_api3_create_success($result, $params, 'contribution_page', 'submit'); | |
108 | } |