4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.7 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2017 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * This api exposes CiviCRM MappingField records.
32 * @package CiviCRM_APIv3
36 * Add a Mapping Field.
38 * @param array $params
42 function civicrm_api3_mapping_field_create($params) {
43 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
47 * Adjust Metadata for Create action.
49 * The metadata is used for setting defaults, documentation & validation.
51 * @param array $params
52 * Array of parameters determined by getfields.
54 function _civicrm_api3_mapping_field_create_spec(&$params) {
55 $params['mapping_id']['api.required'] = 1;
59 * Deletes an existing Mapping Field.
61 * @param array $params
66 function civicrm_api3_mapping_field_delete($params) {
67 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
71 * Retrieve one or more Mapping Fields.
73 * @param array $params
74 * An associative array of name/value pairs.
77 * details of found Mapping Fields
79 function civicrm_api3_mapping_field_get($params) {
80 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);