Commit | Line | Data |
---|---|---|
927f93e2 TM |
1 | <?php |
2 | ||
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
fa938177 | 5 | | CiviCRM version 4.7 | |
927f93e2 | 6 | +--------------------------------------------------------------------+ |
1f4ea726 | 7 | | Copyright CiviCRM LLC (c) 2004-2017 | |
927f93e2 TM |
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 | * This api exposes CiviCRM Mapping records. | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | */ | |
34 | ||
35 | /** | |
36 | * Add a Mapping. | |
37 | * | |
38 | * @param array $params | |
39 | * | |
40 | * @return array | |
41 | */ | |
42 | function civicrm_api3_mapping_create($params) { | |
43 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
44 | } | |
45 | ||
df197a56 | 46 | /** |
47 | * Adjust Metadata for Create action. | |
48 | * | |
49 | * The metadata is used for setting defaults, documentation & validation. | |
50 | * | |
51 | * @param array $spec | |
52 | * Array of parameters determined by getfields. | |
53 | */ | |
54 | function _civicrm_api3_mapping_create_spec(&$spec) { | |
55 | $spec['name']['api.required'] = 1; | |
56 | } | |
57 | ||
927f93e2 TM |
58 | /** |
59 | * Deletes an existing Mapping. | |
60 | * | |
61 | * @param array $params | |
62 | * | |
63 | * @return array | |
64 | * API result Array | |
65 | */ | |
66 | function civicrm_api3_mapping_delete($params) { | |
67 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
68 | } | |
69 | ||
70 | /** | |
71 | * Retrieve one or more Mappings. | |
72 | * | |
73 | * @param array $params | |
74 | * An associative array of name/value pairs. | |
75 | * | |
76 | * @return array | |
77 | * details of found Mappings | |
78 | */ | |
79 | function civicrm_api3_mapping_get($params) { | |
80 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
81 | } |