Pcp.php
This api exposes CiviCRM PCP records.
Table of Contents
Functions
- civicrm_api3_pcp_create() : array<string|int, mixed>
- Create or update a survey.
- _civicrm_api3_pcp_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_pcp_get() : array<string|int, mixed>
- Returns array of pcps matching a set of one or more properties.
- civicrm_api3_pcp_delete() : array<string|int, mixed>
- Delete an existing PCP.
Functions
civicrm_api3_pcp_create()
Create or update a survey.
civicrm_api3_pcp_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> —api result array
_civicrm_api3_pcp_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_pcp_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_pcp_get()
Returns array of pcps matching a set of one or more properties.
civicrm_api3_pcp_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields
Return values
array<string|int, mixed> —Array of matching pcps
civicrm_api3_pcp_delete()
Delete an existing PCP.
civicrm_api3_pcp_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing PCP given its id.
Parameters
- $params : array<string|int, mixed>
-
[id]
Return values
array<string|int, mixed> —api result array