Grant.php
This api exposes CiviCRM Grant records.
Tags
Table of Contents
Functions
- civicrm_api3_grant_create() : array<string|int, mixed>
- Create/update Grant.
- _civicrm_api3_grant_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_grant_get() : array<string|int, mixed>
- Returns array of grants matching a set of one or more properties.
- civicrm_api3_grant_delete() : array<string|int, mixed>
- This method is used to delete an existing Grant.
Functions
civicrm_api3_grant_create()
Create/update Grant.
civicrm_api3_grant_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_grant_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_grant_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_grant_get()
Returns array of grants matching a set of one or more properties.
civicrm_api3_grant_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> —Array of matching grants
civicrm_api3_grant_delete()
This method is used to delete an existing Grant.
civicrm_api3_grant_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Id of the Grant to be deleted is required.
Return values
array<string|int, mixed> —API Result Array