3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM membership status.
15 * @package CiviCRM_APIv3
19 * Create a Membership Status.
21 * @param array $params
22 * Array of name/value property values of civicrm_membership_status.
26 function civicrm_api3_membership_status_create($params) {
27 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'MembershipStatus');
31 * Adjust Metadata for Create action.
33 * The metadata is used for setting defaults, documentation & validation.
35 * @param array $params
36 * Array of parameters determined by getfields.
38 function _civicrm_api3_membership_status_create_spec(&$params) {
39 $params['name']['api.required'] = 1;
43 * Get a membership status.
45 * This api is used for finding an existing membership status.
47 * @param array $params
48 * An associative array of name/value property values of civicrm_membership_status.
51 * Array of all found membership status property values.
53 function civicrm_api3_membership_status_get($params) {
54 return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params);
58 * Update an existing membership status.
60 * This api is used for updating an existing membership status.
61 * Required parameters: id of a membership status
63 * @param array $params
64 * Array of name/value property values of civicrm_membership_status.
66 * @deprecated - should just use create
69 * Array of updated membership status property values
71 function civicrm_api3_membership_status_update($params) {
73 civicrm_api3_verify_mandatory($params, NULL, ['id']);
74 //don't allow duplicate names.
75 $name = CRM_Utils_Array
::value('name', $params);
77 $status = new CRM_Member_DAO_MembershipStatus();
78 $status->name
= $params['name'];
79 if ($status->find(TRUE) && $status->id
!= $params['id']) {
80 return civicrm_api3_create_error(ts('A membership status with this name already exists.'));
84 $membershipStatusBAO = new CRM_Member_BAO_MembershipStatus();
85 $membershipStatusBAO->id
= $params['id'];
86 if ($membershipStatusBAO->find(TRUE)) {
87 $fields = $membershipStatusBAO->fields();
88 foreach ($fields as $name => $field) {
89 if (array_key_exists($name, $params)) {
90 $membershipStatusBAO->$name = $params[$name];
93 $membershipStatusBAO->save();
95 $membershipStatus = [];
96 $cloneBAO = clone($membershipStatusBAO);
97 _civicrm_api3_object_to_array($cloneBAO, $membershipStatus);
98 $membershipStatus['is_error'] = 0;
99 return $membershipStatus;
103 * Deletes an existing membership status.
105 * This API is used for deleting a membership status
107 * @param array $params
109 * @throws API_Exception
110 * @throws CRM_Core_Exception
112 function civicrm_api3_membership_status_delete($params) {
114 $memberStatusDelete = CRM_Member_BAO_MembershipStatus
::del($params['id'], TRUE);
115 if ($memberStatusDelete) {
116 throw new API_Exception($memberStatusDelete['error_message']);
118 return civicrm_api3_create_success();
122 * Derives the Membership Status of a given Membership Record.
124 * This API is used for deriving Membership Status of a given Membership
125 * record using the rules encoded in the membership_status table.
127 * @param array $membershipParams
129 * @throws API_Exception
132 * Array of status id and status name
134 function civicrm_api3_membership_status_calc($membershipParams) {
135 if (!($membershipID = CRM_Utils_Array
::value('membership_id', $membershipParams))) {
136 throw new API_Exception('membershipParams do not contain membership_id');
139 if (empty($membershipParams['id'])) {
140 //for consistency lets make sure id is set as this will get passed to hooks downstream
141 $membershipParams['id'] = $membershipID;
144 SELECT start_date, end_date, join_date, membership_type_id
145 FROM civicrm_membership
149 $params = [1 => [$membershipID, 'Integer']];
150 $dao = CRM_Core_DAO
::executeQuery($query, $params);
152 $membershipTypeID = empty($membershipParams['membership_type_id']) ?
$dao->membership_type_id
: $membershipParams['membership_type_id'];
153 $result = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dao->start_date
, $dao->end_date
, $dao->join_date
, 'today', CRM_Utils_Array
::value('ignore_admin_only', $membershipParams), $membershipTypeID, $membershipParams);
154 //make is error zero only when valid status found.
155 if (!empty($result['id'])) {
156 $result['is_error'] = 0;
160 throw new API_Exception('did not find a membership record');
166 * Adjust Metadata for Calc action.
168 * The metadata is used for setting defaults, documentation & validation.
170 * @param array $params
171 * Array of parameters determined by getfields.
173 function _civicrm_api3_membership_status_calc_spec(&$params) {
174 $params['membership_id']['api.required'] = 1;
175 $params['membership_id']['title'] = 'Membership ID';
176 $params['ignore_admin_only']['title'] = 'Ignore admin only statuses';
177 $params['ignore_admin_only']['description'] = 'Ignore statuses that are for admin/manual assignment only';
178 $params['ignore_admin_only']['type'] = CRM_Utils_Type
::T_BOOLEAN
;