Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 group functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_ContributionPage | |
35 | * @copyright CiviCRM LLC (c) 20042012 | |
36 | */ | |
37 | ||
38 | /** | |
39 | * Create or update a contribution_page | |
40 | * | |
cf470720 TO |
41 | * @param array $params |
42 | * Associative array of property. | |
6a488035 TO |
43 | * name/value pairs to insert in new 'contribution_page' |
44 | * @example ContributionPageCreate.php Std Create example | |
45 | * | |
a6c01b45 CW |
46 | * @return array |
47 | * api result array | |
6a488035 TO |
48 | * {@getfields contribution_page_create} |
49 | * @access public | |
50 | */ | |
51 | function civicrm_api3_contribution_page_create($params) { | |
10a3c9b9 EM |
52 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
53 | CRM_Contribute_PseudoConstant::flush('contributionPageAll'); | |
54 | CRM_Contribute_PseudoConstant::flush('contributionPageActive'); | |
55 | return $result; | |
6a488035 | 56 | } |
11e09c59 TO |
57 | |
58 | /** | |
6a488035 TO |
59 | * Adjust Metadata for Create action |
60 | * | |
61 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
62 | * @param array $params |
63 | * Array or parameters determined by getfields. | |
6a488035 TO |
64 | */ |
65 | function _civicrm_api3_contribution_page_create_spec(&$params) { | |
66 | $params['financial_type_id']['api.required'] = 1; | |
16c0ec8d | 67 | $params['payment_processor']['api.aliases'] = array('payment_processor_id'); |
9fed6619 | 68 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
69 | } |
70 | ||
71 | /** | |
72 | * Returns array of contribution_pages matching a set of one or more group properties | |
73 | * | |
cf470720 TO |
74 | * @param array $params |
75 | * Array of one or more valid property_name=>value pairs. | |
6a488035 | 76 | * |
a6c01b45 CW |
77 | * @return array |
78 | * API Result array Array of matching contribution_pages | |
6a488035 TO |
79 | * {@getfields contribution_page_get} |
80 | * @access public | |
81 | */ | |
82 | function civicrm_api3_contribution_page_get($params) { | |
83 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
84 | } | |
85 | ||
86 | /** | |
87 | * delete an existing contribution_page | |
88 | * | |
89 | * This method is used to delete any existing contribution_page. id of the group | |
90 | * to be deleted is required field in $params array | |
91 | * | |
cf470720 TO |
92 | * @param array $params |
93 | * Array containing id of the group. | |
6a488035 TO |
94 | * to be deleted |
95 | * | |
a6c01b45 CW |
96 | * @return array |
97 | * API result Array | |
6a488035 TO |
98 | * {@getfields contribution_page_delete} |
99 | * @access public | |
100 | */ | |
101 | function civicrm_api3_contribution_page_delete($params) { | |
102 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
103 | } | |
be26f3e0 EM |
104 | |
105 | /** | |
106 | * delete an existing contribution_page | |
107 | * | |
108 | * This method is used to delete any existing contribution_page. id of the group | |
109 | * to be deleted is required field in $params array | |
110 | * | |
cf470720 TO |
111 | * @param array $params |
112 | * (reference) array containing id of the group. | |
be26f3e0 EM |
113 | * to be deleted |
114 | * | |
a6c01b45 CW |
115 | * @return array |
116 | * API result array | |
be26f3e0 EM |
117 | * {@getfields contribution_page_delete} |
118 | * @access public | |
119 | */ | |
120 | function civicrm_api3_contribution_page_submit($params) { | |
121 | $result = CRM_Contribute_Form_Contribution_Confirm::submit($params); | |
122 | return civicrm_api3_create_success($result, $params, 'contribution_page', 'submit'); | |
123 | } |