3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_ContributionPage
34 * @copyright CiviCRM LLC (c) 20042012
38 * Create or update a contribution_page
40 * @param array $params
41 * Associative array of property.
42 * name/value pairs to insert in new 'contribution_page'
43 * @example ContributionPageCreate.php Std Create example
47 * {@getfields contribution_page_create}
49 function civicrm_api3_contribution_page_create($params) {
50 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
51 CRM_Contribute_PseudoConstant
::flush('contributionPageAll');
52 CRM_Contribute_PseudoConstant
::flush('contributionPageActive');
57 * Adjust Metadata for Create action
59 * The metadata is used for setting defaults, documentation & validation
60 * @param array $params
61 * Array or parameters determined by getfields.
63 function _civicrm_api3_contribution_page_create_spec(&$params) {
64 $params['financial_type_id']['api.required'] = 1;
65 $params['payment_processor']['api.aliases'] = array('payment_processor_id');
66 $params['is_active']['api.default'] = 1;
70 * Returns array of contribution_pages matching a set of one or more group properties
72 * @param array $params
73 * Array of one or more valid property_name=>value pairs.
76 * API Result array Array of matching contribution_pages
77 * {@getfields contribution_page_get}
79 function civicrm_api3_contribution_page_get($params) {
80 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
84 * delete an existing contribution_page
86 * This method is used to delete any existing contribution_page. id of the group
87 * to be deleted is required field in $params array
89 * @param array $params
90 * Array containing id of the group.
95 * {@getfields contribution_page_delete}
97 function civicrm_api3_contribution_page_delete($params) {
98 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
102 * delete an existing contribution_page
104 * This method is used to delete any existing contribution_page. id of the group
105 * to be deleted is required field in $params array
107 * @param array $params
108 * (reference) array containing id of the group.
113 * {@getfields contribution_page_delete}
115 function civicrm_api3_contribution_page_submit($params) {
116 $result = CRM_Contribute_Form_Contribution_Confirm
::submit($params);
117 return civicrm_api3_create_success($result, $params, 'contribution_page', 'submit');