3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 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. |
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 +--------------------------------------------------------------------+
30 * This api exposes CiviCRM contribution pages.
32 * @package CiviCRM_APIv3
36 * Create or update a ContributionPage.
38 * @param array $params
39 * Array per getfields metadata.
44 function civicrm_api3_contribution_page_create($params) {
45 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
46 CRM_Contribute_PseudoConstant
::flush('contributionPageAll');
47 CRM_Contribute_PseudoConstant
::flush('contributionPageActive');
52 * Adjust Metadata for Create action.
54 * The metadata is used for setting defaults, documentation & validation.
56 * @param array $params
57 * Array per getfields metadata.
59 function _civicrm_api3_contribution_page_create_spec(&$params) {
60 $params['financial_type_id']['api.required'] = 1;
61 $params['payment_processor']['api.aliases'] = array('payment_processor_id');
62 $params['is_active']['api.default'] = 1;
66 * Returns array of ContributionPage(s) matching a set of one or more group properties.
68 * @param array $params
69 * Array per getfields metadata.
72 * API Result array Array of matching contribution_pages
74 function civicrm_api3_contribution_page_get($params) {
75 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * Delete an existing ContributionPage.
81 * This method is used to delete any existing ContributionPage given its id.
83 * @param array $params
84 * Array per getfields metadata.
89 function civicrm_api3_contribution_page_delete($params) {
90 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
94 * Submit a ContributionPage.
96 * @param array $params
97 * Array per getfields metadata.
102 function civicrm_api3_contribution_page_submit($params) {
103 $result = CRM_Contribute_Form_Contribution_Confirm
::submit($params);
104 return civicrm_api3_create_success($result, $params, 'ContributionPage', 'submit');
109 * Set default getlist parameters.
111 * @see _civicrm_api3_generic_getlist_defaults
113 * @param array $request
117 function _civicrm_api3_contribution_page_getlist_defaults(&$request) {
119 'description_field' => array(