MembershipStatus.php
This api exposes CiviCRM membership status.
Table of Contents
Functions
- civicrm_api3_membership_status_create() : array<string|int, mixed>
- Create a Membership Status.
- _civicrm_api3_membership_status_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_membership_status_get() : array<string|int, mixed>
- Get a membership status.
- civicrm_api3_membership_status_update() : array<string|int, mixed>
- Update an existing membership status.
- civicrm_api3_membership_status_delete() : array<string|int, mixed>
- Deletes an existing membership status.
- civicrm_api3_membership_status_calc() : array<string|int, mixed>
- Derives the Membership Status of a given Membership Record.
- _civicrm_api3_membership_status_calc_spec() : mixed
- Adjust Metadata for Calc action.
Functions
civicrm_api3_membership_status_create()
Create a Membership Status.
civicrm_api3_membership_status_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of name/value property values of civicrm_membership_status.
Return values
array<string|int, mixed>_civicrm_api3_membership_status_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_membership_status_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_membership_status_get()
Get a membership status.
civicrm_api3_membership_status_get(array<string|int, mixed> $params) : array<string|int, mixed>
This api is used for finding an existing membership status.
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of civicrm_membership_status.
Return values
array<string|int, mixed> —Array of all found membership status property values.
civicrm_api3_membership_status_update()
Update an existing membership status.
- should just use create
civicrm_api3_membership_status_update(array<string|int, mixed> $params) : array<string|int, mixed>
This api is used for updating an existing membership status. Required parameters: id of a membership status
Parameters
- $params : array<string|int, mixed>
-
Array of name/value property values of civicrm_membership_status.
Return values
array<string|int, mixed> —Array of updated membership status property values
civicrm_api3_membership_status_delete()
Deletes an existing membership status.
civicrm_api3_membership_status_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a membership status
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_membership_status_calc()
Derives the Membership Status of a given Membership Record.
civicrm_api3_membership_status_calc(array<string|int, mixed> $membershipParams) : array<string|int, mixed>
This API is used for deriving Membership Status of a given Membership record using the rules encoded in the membership_status table.
Parameters
- $membershipParams : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of status id and status name
_civicrm_api3_membership_status_calc_spec()
Adjust Metadata for Calc action.
_civicrm_api3_membership_status_calc_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.