Mapping.php
This api exposes CiviCRM Mapping records.
Table of Contents
Functions
- civicrm_api3_mapping_create() : array<string|int, mixed>
- Add a Mapping.
- _civicrm_api3_mapping_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_mapping_delete() : array<string|int, mixed>
- Deletes an existing Mapping.
- civicrm_api3_mapping_get() : array<string|int, mixed>
- Retrieve one or more Mappings.
Functions
civicrm_api3_mapping_create()
Add a Mapping.
civicrm_api3_mapping_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_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_mapping_create_spec(array<string|int, mixed> &$spec) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $spec : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_mapping_delete()
Deletes an existing Mapping.
civicrm_api3_mapping_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_get()
Retrieve one or more Mappings.
civicrm_api3_mapping_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 Mappings