ContributionPage.php
This api exposes CiviCRM contribution pages.
Table of Contents
Functions
- civicrm_api3_contribution_page_create() : array<string|int, mixed>
- Create or update a ContributionPage.
- _civicrm_api3_contribution_page_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_contribution_page_get() : array<string|int, mixed>
- Returns array of ContributionPage(s) matching a set of one or more group properties.
- civicrm_api3_contribution_page_delete() : array<string|int, mixed>
- Delete an existing ContributionPage.
- civicrm_api3_contribution_page_submit() : array<string|int, mixed>
- Submit a ContributionPage.
- civicrm_api3_contribution_page_validate() : array<string|int, mixed>
- Validate ContributionPage submission parameters.
- _civicrm_api3_contribution_page_validate_spec() : mixed
- Metadata for validate action.
- _civicrm_api3_contribution_page_getlist_defaults() : array<string|int, mixed>
- Set default getlist parameters.
- _civicrm_api3_contribution_page_deprecation() : array<string|int, mixed>
Functions
civicrm_api3_contribution_page_create()
Create or update a ContributionPage.
civicrm_api3_contribution_page_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_contribution_page_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_contribution_page_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
civicrm_api3_contribution_page_get()
Returns array of ContributionPage(s) matching a set of one or more group properties.
civicrm_api3_contribution_page_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 Array of matching contribution_pages
civicrm_api3_contribution_page_delete()
Delete an existing ContributionPage.
civicrm_api3_contribution_page_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing ContributionPage given its id.
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result Array
civicrm_api3_contribution_page_submit()
Submit a ContributionPage.
civicrm_api3_contribution_page_submit(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_contribution_page_validate()
Validate ContributionPage submission parameters.
civicrm_api3_contribution_page_validate(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_contribution_page_validate_spec()
Metadata for validate action.
_civicrm_api3_contribution_page_validate_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_contribution_page_getlist_defaults()
Set default getlist parameters.
_civicrm_api3_contribution_page_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>
Parameters
- $request : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_contribution_page_deprecation()
_civicrm_api3_contribution_page_deprecation() : array<string|int, mixed>