Country.php
This api exposes CiviCRM country.
Table of Contents
Functions
- civicrm_api3_country_create() : array<string|int, mixed>
- Add an Country for a contact.
- _civicrm_api3_country_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_country_delete() : array<string|int, mixed>
- Deletes an existing Country.
- civicrm_api3_country_get() : array<string|int, mixed>
- Retrieve one or more countryies.
Functions
civicrm_api3_country_create()
Add an Country for a contact.
civicrm_api3_country_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_country_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_country_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_country_delete()
Deletes an existing Country.
civicrm_api3_country_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_country_get()
Retrieve one or more countryies.
civicrm_api3_country_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —api result array