MappingField.php
This api exposes CiviCRM MappingField records.
Table of Contents
Functions
- civicrm_api3_mapping_field_create() : array<string|int, mixed>
- Add a Mapping Field.
- _civicrm_api3_mapping_field_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_mapping_field_delete() : array<string|int, mixed>
- Deletes an existing Mapping Field.
- civicrm_api3_mapping_field_get() : array<string|int, mixed>
- Retrieve one or more Mapping Fields.
Functions
civicrm_api3_mapping_field_create()
Add a Mapping Field.
civicrm_api3_mapping_field_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_mapping_field_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mapping_field_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_mapping_field_delete()
Deletes an existing Mapping Field.
civicrm_api3_mapping_field_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result Array
civicrm_api3_mapping_field_get()
Retrieve one or more Mapping Fields.
civicrm_api3_mapping_field_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value pairs.
Return values
array<string|int, mixed> —details of found Mapping Fields