Commit | Line | Data |
---|---|---|
5c065cc0 | 1 | <?php |
5c065cc0 JL |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
5c065cc0 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
5c065cc0 JL |
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 | */ |
5c065cc0 JL |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM soft credits. |
5c065cc0 JL |
30 | * |
31 | * @package CiviCRM_APIv3 | |
5c065cc0 JL |
32 | */ |
33 | ||
34 | /** | |
9d32e6f7 | 35 | * Create or Update a Soft Credit. |
5c065cc0 | 36 | * |
cf470720 | 37 | * @param array $params |
9d32e6f7 | 38 | * Array per getfields metadata. |
5c065cc0 | 39 | * |
9d32e6f7 EM |
40 | * @return array |
41 | * API result array | |
5c065cc0 JL |
42 | */ |
43 | function civicrm_api3_contribution_soft_create($params) { | |
44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
45 | } | |
46 | ||
47 | /** | |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
5c065cc0 | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
5c065cc0 JL |
54 | */ |
55 | function _civicrm_api3_contribution_soft_create_spec(&$params) { | |
56 | $params['contribution_id']['api.required'] = 1; | |
57 | $params['contact_id']['api.required'] = 1; | |
58 | $params['amount']['api.required'] = 1; | |
59 | } | |
60 | ||
61 | /** | |
9d32e6f7 | 62 | * Deletes an existing Soft Credit. |
5c065cc0 | 63 | * |
cf470720 | 64 | * @param array $params |
fae69387 | 65 | * |
66 | * @return array | |
67 | * Api formatted result. | |
68 | * | |
8089541a | 69 | * @throws API_Exception |
5c065cc0 JL |
70 | */ |
71 | function civicrm_api3_contribution_soft_delete($params) { | |
fae69387 | 72 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
5c065cc0 JL |
73 | } |
74 | ||
75 | /** | |
9d32e6f7 | 76 | * Retrieve one or more Soft Credits. |
5c065cc0 | 77 | * |
2e66abf8 EM |
78 | * @param array $params |
79 | * Array per getfields metadata. | |
5c065cc0 | 80 | * |
2e66abf8 | 81 | * @return array |
78373706 | 82 | * API result |
5c065cc0 JL |
83 | */ |
84 | function civicrm_api3_contribution_soft_get($params) { | |
85 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
86 | } |