Commit | Line | Data |
---|---|---|
5c065cc0 JL |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
232624b1 | 6 | | CiviCRM version 4.4 | |
5c065cc0 JL |
7 | +--------------------------------------------------------------------+ |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 soft credit functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_ContributionSoft | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $ | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Create or Update a Soft Credit | |
42 | * | |
43 | * @param array $params Associative array of property | |
44 | * name/value pairs to insert in new 'contribution_soft' | |
45 | * | |
46 | * @example ContributionSoftCreate.php Standard Create Example //FIXME | |
47 | * | |
48 | * @return array API result array | |
49 | * {@getfields contribution_soft_create} | |
50 | * @access public | |
51 | */ | |
52 | function civicrm_api3_contribution_soft_create($params) { | |
53 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
54 | } | |
55 | ||
56 | /** | |
57 | * Adjust Metadata for Create action | |
58 | * | |
59 | * The metadata is used for setting defaults, documentation & validation | |
60 | * @param array $params array or parameters determined by getfields | |
61 | */ | |
62 | function _civicrm_api3_contribution_soft_create_spec(&$params) { | |
63 | $params['contribution_id']['api.required'] = 1; | |
64 | $params['contact_id']['api.required'] = 1; | |
65 | $params['amount']['api.required'] = 1; | |
66 | } | |
67 | ||
68 | /** | |
69 | * Deletes an existing Soft Credit | |
70 | * | |
71 | * @param array $params | |
72 | * | |
73 | * @example ContributionSoftDelete.php Standard Delete Example | |
74 | * | |
75 | * @return boolean | error true if successfull, error otherwise | |
76 | * {@getfields contribution_soft_delete} | |
77 | * @access public | |
78 | */ | |
79 | function civicrm_api3_contribution_soft_delete($params) { | |
b5fb8b6f | 80 | // non standard BAO - we have to write custom code to cope |
81 | CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id'])); | |
82 | ||
5c065cc0 JL |
83 | } |
84 | ||
85 | /** | |
86 | * Retrieve one or more Soft Credits | |
87 | * | |
88 | * @param array input parameters | |
89 | * | |
90 | * | |
91 | * @example ContributionSoftGet.php Standard Get Example | |
92 | * | |
93 | * @param array $params an associative array of name/value pairs. | |
94 | * | |
95 | * @return array api result | |
96 | * {@getfields contribution_soft_get} | |
97 | * @access public | |
98 | */ | |
99 | function civicrm_api3_contribution_soft_get($params) { | |
100 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
101 | } | |
102 |