Address.php
This api exposes CiviCRM Address records.
Table of Contents
Functions
- civicrm_api3_address_create() : array<string|int, mixed>
- Add an Address for a contact.
- _civicrm_api3_address_create_spec() : mixed
- Adjust Metadata for Create action.
- _civicrm_api3_address_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_address_delete() : array<string|int, mixed>
- Delete an existing Address.
- civicrm_api3_address_get() : array<string|int, mixed>
- Retrieve one or more addresses.
Functions
civicrm_api3_address_create()
Add an Address for a contact.
civicrm_api3_address_create(array<string|int, mixed> $params) : array<string|int, mixed>
FIXME: Should be using basic_create util
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_address_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_address_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
_civicrm_api3_address_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_address_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_address_delete()
Delete an existing Address.
civicrm_api3_address_delete(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
civicrm_api3_address_get()
Retrieve one or more addresses.
civicrm_api3_address_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