Minor tidyup of api3 completetransaction; plus comments
[civicrm-core.git] / api / v3 / Exception.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
5 | |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
10 */
11
12 /**
13 * Get a Dedupe Exception.
14 *
15 * @param array $params
16 * Array per getfields metadata.
17 *
18 * @return array
19 * Array of all found dedupe exception object property values.
20 */
21 function civicrm_api3_exception_get($params) {
22 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
23 }
24
25 /**
26 * Create or update an dedupe exception.
27 *
28 * @param array $params
29 * Array per getfields metadata.
30 *
31 * @return array api result array
32 */
33 function civicrm_api3_exception_create($params) {
34 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'DedupeException');
35 }
36
37 /**
38 * Delete an existing Exception.
39 *
40 * This method is used to delete any existing Exception given its id.
41 *
42 * @param array $params
43 * [id]
44 *
45 * @return array api result array
46 */
47 function civicrm_api3_exception_delete($params) {
48 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
49 }