Order.php
This api exposes CiviCRM Order objects, an abstract entity comprised of contributions and related line items.
Table of Contents
Functions
- civicrm_api3_order_get() : array<string|int, mixed>
- Retrieve a set of Order.
- _civicrm_api3_order_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_order_create() : array<string|int, mixed>
- Add or update a Order.
- civicrm_api3_order_delete() : array<string|int, mixed>
- Delete a Order.
- civicrm_api3_order_cancel() : array<string|int, mixed>
- Cancel an Order.
- _civicrm_api3_order_cancel_spec() : mixed
- Adjust Metadata for Cancel action.
- _civicrm_api3_order_create_spec() : mixed
- Adjust Metadata for Create action.
- _civicrm_api3_order_delete_spec() : mixed
- Adjust Metadata for Delete action.
- _order_create_wrangle_membership_params() : mixed
- Handle possibility of v3 style params.
Functions
civicrm_api3_order_get()
Retrieve a set of Order.
civicrm_api3_order_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —Array of Order, if error an array with an error id and error message
_civicrm_api3_order_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_order_get_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_order_create()
Add or update a Order.
civicrm_api3_order_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —Api result array
civicrm_api3_order_delete()
Delete a Order.
civicrm_api3_order_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed>civicrm_api3_order_cancel()
Cancel an Order.
civicrm_api3_order_cancel(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed>_civicrm_api3_order_cancel_spec()
Adjust Metadata for Cancel action.
_civicrm_api3_order_cancel_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_order_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_order_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_order_delete_spec()
Adjust Metadata for Delete action.
_civicrm_api3_order_delete_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.
_order_create_wrangle_membership_params()
Handle possibility of v3 style params.
_order_create_wrangle_membership_params(array<string|int, mixed> &$membershipParams) : mixed
We used to call v3 Membership.create. Now we call v4. This converts membership input parameters.
Parameters
- $membershipParams : array<string|int, mixed>