PriceField.php
This api exposes CiviCRM price set fields.
PriceSets contain PriceFields, which may contain PriceFieldValues. Each has its own api. Use chaining to create a PriceSet and associated PriceFields and values in one api call.
Table of Contents
Functions
- civicrm_api3_price_field_create() : array<string|int, mixed>
- Create or update a price_field.
- _civicrm_api3_price_field_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_price_field_get() : array<string|int, mixed>
- Returns array of price_fields matching a set of one or more group properties.
- civicrm_api3_price_field_delete() : array<string|int, mixed>
- Delete an existing price_field.
Functions
civicrm_api3_price_field_create()
Create or update a price_field.
civicrm_api3_price_field_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
name/value pairs to insert in new 'price_field'
Return values
array<string|int, mixed> —api result array
_civicrm_api3_price_field_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_price_field_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_price_field_get()
Returns array of price_fields matching a set of one or more group properties.
civicrm_api3_price_field_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of one or more valid property_name=>value pairs. If $params is set. as null, all price_fields will be returned (default limit is 25)
Return values
array<string|int, mixed> —Array of matching price_fields
civicrm_api3_price_field_delete()
Delete an existing price_field.
civicrm_api3_price_field_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing price_field given its id.
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the group to be deleted.
Return values
array<string|int, mixed> —API result array