Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
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 batch functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Batch | |
35 | * | |
36 | */ | |
37 | ||
38 | /** | |
39 | * Save a Batch | |
40 | * | |
41 | * Allowed @params array keys are: | |
42 | * {@getfields batch_create} | |
43 | * @example BatchCreate.php | |
44 | * | |
45 | * @return array of newly created batch property values. | |
46 | * @access public | |
47 | */ | |
48 | function civicrm_api3_batch_create($params) { | |
49 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
50 | } | |
51 | ||
52 | /** | |
53 | * Get a Batch | |
54 | * | |
55 | * Allowed @params array keys are: | |
56 | * {@getfields batch_get} | |
57 | * @example BatchCreate.php | |
58 | * | |
59 | * @return array of retrieved batch property values. | |
60 | * @access public | |
61 | */ | |
62 | function civicrm_api3_batch_get($params) { | |
63 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
64 | } | |
65 | ||
66 | /** | |
67 | * Delete a Batch | |
68 | * | |
69 | * Allowed @params array keys are: | |
70 | * {@getfields batch_delete} | |
71 | * @example BatchCreate.php | |
72 | * | |
73 | * @return array of deleted values. | |
74 | * @access public | |
75 | */ | |
76 | function civicrm_api3_batch_delete($params) { | |
77 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } |