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 | +--------------------------------------------------------------------+ | |
26 | */ | |
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 | /** | |
38 | * Create or update a contribution_page | |
39 | * | |
cf470720 TO |
40 | * @param array $params |
41 | * Associative array of property. | |
6a488035 TO |
42 | * name/value pairs to insert in new 'contribution_page' |
43 | * @example ContributionPageCreate.php Std Create example | |
44 | * | |
a6c01b45 | 45 | * @return array |
72b3a70c | 46 | * api result array |
6a488035 | 47 | * {@getfields contribution_page_create} |
6a488035 TO |
48 | */ |
49 | function civicrm_api3_contribution_page_create($params) { | |
10a3c9b9 EM |
50 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
51 | CRM_Contribute_PseudoConstant::flush('contributionPageAll'); | |
52 | CRM_Contribute_PseudoConstant::flush('contributionPageActive'); | |
53 | return $result; | |
6a488035 | 54 | } |
11e09c59 TO |
55 | |
56 | /** | |
6a488035 TO |
57 | * Adjust Metadata for Create action |
58 | * | |
59 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
60 | * @param array $params |
61 | * Array or parameters determined by getfields. | |
6a488035 TO |
62 | */ |
63 | function _civicrm_api3_contribution_page_create_spec(&$params) { | |
64 | $params['financial_type_id']['api.required'] = 1; | |
16c0ec8d | 65 | $params['payment_processor']['api.aliases'] = array('payment_processor_id'); |
9fed6619 | 66 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
67 | } |
68 | ||
69 | /** | |
70 | * Returns array of contribution_pages matching a set of one or more group properties | |
71 | * | |
cf470720 TO |
72 | * @param array $params |
73 | * Array of one or more valid property_name=>value pairs. | |
6a488035 | 74 | * |
a6c01b45 | 75 | * @return array |
72b3a70c | 76 | * API Result array Array of matching contribution_pages |
6a488035 | 77 | * {@getfields contribution_page_get} |
6a488035 TO |
78 | */ |
79 | function civicrm_api3_contribution_page_get($params) { | |
80 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
81 | } | |
82 | ||
83 | /** | |
84 | * delete an existing contribution_page | |
85 | * | |
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 | |
88 | * | |
cf470720 TO |
89 | * @param array $params |
90 | * Array containing id of the group. | |
6a488035 TO |
91 | * to be deleted |
92 | * | |
a6c01b45 | 93 | * @return array |
72b3a70c | 94 | * API result Array |
6a488035 | 95 | * {@getfields contribution_page_delete} |
6a488035 TO |
96 | */ |
97 | function civicrm_api3_contribution_page_delete($params) { | |
98 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
99 | } | |
be26f3e0 EM |
100 | |
101 | /** | |
102 | * delete an existing contribution_page | |
103 | * | |
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 | |
106 | * | |
cf470720 TO |
107 | * @param array $params |
108 | * (reference) array containing id of the group. | |
be26f3e0 EM |
109 | * to be deleted |
110 | * | |
a6c01b45 | 111 | * @return array |
72b3a70c | 112 | * API result array |
be26f3e0 | 113 | * {@getfields contribution_page_delete} |
be26f3e0 EM |
114 | */ |
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'); | |
118 | } |