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_LineItem | |
35 | * @copyright CiviCRM LLC (c) 20042012 | |
36 | */ | |
37 | ||
38 | /** | |
39 | * Create or update a line_item | |
40 | * | |
cf470720 TO |
41 | * @param array $params |
42 | * Associative array of property. | |
6a488035 TO |
43 | * name/value pairs to insert in new 'line_item' |
44 | * @example LineItemCreate.php Std Create example | |
45 | * | |
46 | * @return array api result array | |
47 | * {@getfields line_item_create} | |
48 | * @access public | |
49 | */ | |
50 | function civicrm_api3_line_item_create($params) { | |
b5935203 | 51 | $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params,True); |
6a488035 TO |
52 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
53 | } | |
11e09c59 TO |
54 | |
55 | /** | |
6a488035 TO |
56 | * Adjust Metadata for Create action |
57 | * | |
58 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
59 | * @param array $params |
60 | * Array or parameters determined by getfields. | |
6a488035 TO |
61 | */ |
62 | function _civicrm_api3_line_item_create_spec(&$params) { | |
63 | $params['entity_id']['api.required'] = 1; | |
64 | $params['qty']['api.required'] = 1; | |
65 | $params['unit_price']['api.required'] = 1; | |
66 | $params['line_total']['api.required'] = 1; | |
67 | $params['label']['api.default'] = 'line item'; | |
68 | } | |
69 | ||
70 | /** | |
71 | * Returns array of line_items matching a set of one or more group properties | |
72 | * | |
cf470720 TO |
73 | * @param array $params |
74 | * Array of one or more valid property_name=>value pairs. If $params is set. | |
6a488035 TO |
75 | * as null, all line_items will be returned (default limit is 25) |
76 | * | |
77 | * @return array Array of matching line_items | |
78 | * {@getfields line_item_get} | |
79 | * @access public | |
80 | */ | |
81 | function civicrm_api3_line_item_get($params) { | |
82 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
83 | } | |
84 | ||
85 | /** | |
86 | * delete an existing line_item | |
87 | * | |
88 | * This method is used to delete any existing line_item. id of the group | |
89 | * to be deleted is required field in $params array | |
90 | * | |
cf470720 TO |
91 | * @param array $params |
92 | * Array containing id of the group. | |
6a488035 TO |
93 | * to be deleted |
94 | * | |
c206647d | 95 | * @return array API result array |
6a488035 TO |
96 | * {@getfields line_item_delete} |
97 | * @access public | |
98 | */ | |
99 | function civicrm_api3_line_item_delete($params) { | |
100 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
101 | } |