RelationshipType.php
This api exposes CiviCRM relationship types.
Table of Contents
Functions
- civicrm_api3_relationship_type_create() : array<string|int, mixed>
- Create relationship type.
- _civicrm_api3_relationship_type_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_relationship_type_get() : array<string|int, mixed>
- Get all relationship types.
- civicrm_api3_relationship_type_delete() : array<string|int, mixed>
- Delete a relationship type.
- _civicrm_api3_relationship_type_getlist_defaults() : array<string|int, mixed>
- Get list defaults for relationship types.
Functions
civicrm_api3_relationship_type_create()
Create relationship type.
civicrm_api3_relationship_type_create(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>_civicrm_api3_relationship_type_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_relationship_type_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_relationship_type_get()
Get all relationship types.
civicrm_api3_relationship_type_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_relationship_type_delete()
Delete a relationship type.
civicrm_api3_relationship_type_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_relationship_type_getlist_defaults()
Get list defaults for relationship types.
_civicrm_api3_relationship_type_getlist_defaults(array<string|int, mixed> $request) : array<string|int, mixed>
Parameters
- $request : array<string|int, mixed>