Pledge.php
This api exposes CiviCRM Pledge.
Table of Contents
Functions
- civicrm_api3_pledge_create() : array<string|int, mixed>
- Create or updates an Pledge.
- civicrm_api3_pledge_delete() : array<string|int, mixed>
- Delete a pledge.
- _civicrm_api3_pledge_delete_spec() : mixed
- Adjust metadata for pledge delete action.
- _civicrm_api3_pledge_get_spec() : mixed
- Adjust field specification specific to get requests.
- _civicrm_api3_pledge_create_spec() : mixed
- Adjust field specification specific to get requests.
- civicrm_api3_pledge_get() : array<string|int, mixed>
- Retrieve a set of pledges, given a set of input params.
- _civicrm_api3_pledge_get_defaults() : mixed
- Set default to not return test params.
- _civicrm_api3_pledge_format_params() : mixed
- Legacy function to format pledge parameters.
Functions
civicrm_api3_pledge_create()
Create or updates an Pledge.
civicrm_api3_pledge_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array containing 'is_error' to denote success or failure and details of the created pledge
civicrm_api3_pledge_delete()
Delete a pledge.
civicrm_api3_pledge_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array included 'pledge_id' of pledge to delete.
Return values
array<string|int, mixed>_civicrm_api3_pledge_delete_spec()
Adjust metadata for pledge delete action.
_civicrm_api3_pledge_delete_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_pledge_get_spec()
Adjust field specification specific to get requests.
_civicrm_api3_pledge_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_pledge_create_spec()
Adjust field specification specific to get requests.
_civicrm_api3_pledge_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_pledge_get()
Retrieve a set of pledges, given a set of input params.
civicrm_api3_pledge_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters. Use interrogate for possible fields.
Return values
array<string|int, mixed> —array of pledges, if error an array with an error id and error message
_civicrm_api3_pledge_get_defaults()
Set default to not return test params.
_civicrm_api3_pledge_get_defaults() : mixed
_civicrm_api3_pledge_format_params()
Legacy function to format pledge parameters.
_civicrm_api3_pledge_format_params(array<string|int, mixed> &$values) : mixed
I removed a bunch of stuff no longer required from here but it still needs more culling take the input parameter list as specified in the data model and convert it into the same format that we use in QF and BAO object
Parameters
- $values : array<string|int, mixed>
-
The reformatted properties that we can use internally.