3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 membership status functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Membership
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: MembershipStatus.php 30171 2010-10-14 09:11:27Z mover $
39 * Create a Membership Status.
41 * @param array $params
42 * Array of name/value property values of civicrm_membership_status.
45 * Array of newly created membership status property values.
47 function civicrm_api3_membership_status_create($params) {
48 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
52 * Get a membership status.
54 * This api is used for finding an existing membership status.
56 * @param array $params
57 * An associative array of name/value property values of civicrm_membership_status.
60 * Array of all found membership status property values.
61 * {@getfields MembershipStatus_get}
63 function civicrm_api3_membership_status_get($params) {
64 return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params);
68 * Update an existing membership status.
70 * This api is used for updating an existing membership status.
71 * Required parameters : id of a membership status
73 * @param array $params
74 * Array of name/value property values of civicrm_membership_status.
76 * @deprecated - should just use create
79 * Array of updated membership status property values
81 function civicrm_api3_membership_status_update($params) {
83 civicrm_api3_verify_mandatory($params, NULL, array('id'));
84 //don't allow duplicate names.
85 $name = CRM_Utils_Array
::value('name', $params);
87 $status = new CRM_Member_DAO_MembershipStatus();
88 $status->name
= $params['name'];
89 if ($status->find(TRUE) && $status->id
!= $params['id']) {
90 return civicrm_api3_create_error(ts('A membership status with this name already exists.'));
94 $membershipStatusBAO = new CRM_Member_BAO_MembershipStatus();
95 $membershipStatusBAO->id
= $params['id'];
96 if ($membershipStatusBAO->find(TRUE)) {
97 $fields = $membershipStatusBAO->fields();
98 foreach ($fields as $name => $field) {
99 if (array_key_exists($name, $params)) {
100 $membershipStatusBAO->$name = $params[$name];
103 $membershipStatusBAO->save();
105 $membershipStatus = array();
106 _civicrm_api3_object_to_array(clone($membershipStatusBAO), $membershipStatus);
107 $membershipStatus['is_error'] = 0;
108 return $membershipStatus;
112 * Deletes an existing membership status.
114 * This API is used for deleting a membership status
116 * @param array $params
120 function civicrm_api3_membership_status_delete($params) {
122 $memberStatusDelete = CRM_Member_BAO_MembershipStatus
::del($params['id'], TRUE);
123 return $memberStatusDelete ?
civicrm_api3_create_error($memberStatusDelete['error_message']) : civicrm_api3_create_success();
127 * Derives the Membership Status of a given Membership Record.
129 * This API is used for deriving Membership Status of a given Membership
130 * record using the rules encoded in the membership_status table.
132 * @param array $membershipParams
134 * @throws API_Exception
137 * Array of status id and status name
139 function civicrm_api3_membership_status_calc($membershipParams) {
140 if (!($membershipID = CRM_Utils_Array
::value('membership_id', $membershipParams))) {
141 throw new API_Exception('membershipParams do not contain membership_id');
144 if (empty($membershipParams['id'])) {
145 //for consistency lets make sure id is set as this will get passed to hooks downstream
146 $membershipParams['id'] = $membershipID;
149 SELECT start_date, end_date, join_date, membership_type_id
150 FROM civicrm_membership
154 $params = array(1 => array($membershipID, 'Integer'));
155 $dao = CRM_Core_DAO
::executeQuery($query, $params);
157 $membershipTypeID = empty($membershipParams['membership_type_id']) ?
$dao->membership_type_id
: $membershipParams['membership_type_id'];
158 $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);
159 //make is error zero only when valid status found.
160 if (!empty($result['id'])) {
161 $result['is_error'] = 0;
166 throw new API_Exception('did not find a membership record');