Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
232624b1 | 5 | | CiviCRM version 4.4 | |
6a488035 TO |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | * | |
41 | * @param array $params Associative array of property | |
42 | * name/value pairs to insert in new 'line_item' | |
43 | * @example LineItemCreate.php Std Create example | |
44 | * | |
45 | * @return array api result array | |
46 | * {@getfields line_item_create} | |
47 | * @access public | |
48 | */ | |
49 | function civicrm_api3_line_item_create($params) { | |
50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
51 | } | |
11e09c59 TO |
52 | |
53 | /** | |
6a488035 TO |
54 | * Adjust Metadata for Create action |
55 | * | |
56 | * The metadata is used for setting defaults, documentation & validation | |
57 | * @param array $params array or parameters determined by getfields | |
58 | */ | |
59 | function _civicrm_api3_line_item_create_spec(&$params) { | |
60 | $params['entity_id']['api.required'] = 1; | |
61 | $params['qty']['api.required'] = 1; | |
62 | $params['unit_price']['api.required'] = 1; | |
63 | $params['line_total']['api.required'] = 1; | |
64 | $params['label']['api.default'] = 'line item'; | |
65 | } | |
66 | ||
67 | /** | |
68 | * Returns array of line_items matching a set of one or more group properties | |
69 | * | |
70 | * @param array $params Array of one or more valid property_name=>value pairs. If $params is set | |
71 | * as null, all line_items will be returned (default limit is 25) | |
72 | * | |
73 | * @return array Array of matching line_items | |
74 | * {@getfields line_item_get} | |
75 | * @access public | |
76 | */ | |
77 | function civicrm_api3_line_item_get($params) { | |
78 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
79 | } | |
80 | ||
81 | /** | |
82 | * delete an existing line_item | |
83 | * | |
84 | * This method is used to delete any existing line_item. id of the group | |
85 | * to be deleted is required field in $params array | |
86 | * | |
87 | * @param array $params array containing id of the group | |
88 | * to be deleted | |
89 | * | |
90 | * @return array returns flag true if successfull, error message otherwise | |
91 | * {@getfields line_item_delete} | |
92 | * @access public | |
93 | */ | |
94 | function civicrm_api3_line_item_delete($params) { | |
95 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
96 | } |