api/v3/MembershipStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM membership status.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create a Membership Status.
  36  *
  37  * @param array $params
  38  *   Array of name/value property values of civicrm_membership_status.
  39  *
  40  * @return array
  41  */
  42 function civicrm_api3_membership_status_create($params) {
  43   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'MembershipStatus');
  44 }
  45
  46 /**
  47  * Adjust Metadata for Create action.
  48  *
  49  * The metadata is used for setting defaults, documentation & validation.
  50  *
  51  * @param array $params
  52  *   Array of parameters determined by getfields.
  53  */
  54 function _civicrm_api3_membership_status_create_spec(&$params) {
  55   $params['name']['api.required'] = 1;
  56 }
  57
  58 /**
  59  * Get a membership status.
  60  *
  61  * This api is used for finding an existing membership status.
  62  *
  63  * @param array $params
  64  *   An associative array of name/value property values of civicrm_membership_status.
  65  *
  66  * @return array
  67  *   Array of all found membership status property values.
  68  */
  69 function civicrm_api3_membership_status_get($params) {
  70   return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params);
  71 }
  72
  73 /**
  74  * Update an existing membership status.
  75  *
  76  * This api is used for updating an existing membership status.
  77  * Required parameters: id of a membership status
  78  *
  79  * @param array $params
  80  *   Array of name/value property values of civicrm_membership_status.
  81  *
  82  * @deprecated - should just use create
  83  *
  84  * @return array
  85  *   Array of updated membership status property values
  86  */
  87 function civicrm_api3_membership_status_update($params) {
  88
  89   civicrm_api3_verify_mandatory($params, NULL, array('id'));
  90   //don't allow duplicate names.
  91   $name = CRM_Utils_Array::value('name', $params);
  92   if ($name) {
  93     $status = new CRM_Member_DAO_MembershipStatus();
  94     $status->name = $params['name'];
  95     if ($status->find(TRUE) && $status->id != $params['id']) {
  96       return civicrm_api3_create_error(ts('A membership status with this name already exists.'));
  97     }
  98   }
  99
 100   $membershipStatusBAO = new CRM_Member_BAO_MembershipStatus();
 101   $membershipStatusBAO->id = $params['id'];
 102   if ($membershipStatusBAO->find(TRUE)) {
 103     $fields = $membershipStatusBAO->fields();
 104     foreach ($fields as $name => $field) {
 105       if (array_key_exists($name, $params)) {
 106         $membershipStatusBAO->$name = $params[$name];
 107       }
 108     }
 109     $membershipStatusBAO->save();
 110   }
 111   $membershipStatus = array();
 112   $cloneBAO = clone($membershipStatusBAO);
 113   _civicrm_api3_object_to_array($cloneBAO, $membershipStatus);
 114   $membershipStatus['is_error'] = 0;
 115   return $membershipStatus;
 116 }
 117
 118 /**
 119  * Deletes an existing membership status.
 120  *
 121  * This API is used for deleting a membership status
 122  *
 123  * @param array $params
 124  * @return array
 125  * @throws API_Exception
 126  * @throws CRM_Core_Exception
 127  */
 128 function civicrm_api3_membership_status_delete($params) {
 129
 130   $memberStatusDelete = CRM_Member_BAO_MembershipStatus::del($params['id'], TRUE);
 131   if ($memberStatusDelete) {
 132     throw new API_Exception($memberStatusDelete['error_message']);
 133   }
 134   return civicrm_api3_create_success();
 135 }
 136
 137 /**
 138  * Derives the Membership Status of a given Membership Record.
 139  *
 140  * This API is used for deriving Membership Status of a given Membership
 141  * record using the rules encoded in the membership_status table.
 142  *
 143  * @param array $membershipParams
 144  *
 145  * @throws API_Exception
 146  *
 147  * @return array
 148  *   Array of status id and status name
 149  */
 150 function civicrm_api3_membership_status_calc($membershipParams) {
 151   if (!($membershipID = CRM_Utils_Array::value('membership_id', $membershipParams))) {
 152     throw new API_Exception('membershipParams do not contain membership_id');
 153   }
 154
 155   if (empty($membershipParams['id'])) {
 156     //for consistency lets make sure id is set as this will get passed to hooks downstream
 157     $membershipParams['id'] = $membershipID;
 158   }
 159   $query = "
 160 SELECT start_date, end_date, join_date, membership_type_id
 161   FROM civicrm_membership
 162  WHERE id = %1
 163 ";
 164
 165   $params = array(1 => array($membershipID, 'Integer'));
 166   $dao = CRM_Core_DAO::executeQuery($query, $params);
 167   if ($dao->fetch()) {
 168     $membershipTypeID = empty($membershipParams['membership_type_id']) ? $dao->membership_type_id : $membershipParams['membership_type_id'];
 169     $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);
 170     //make is error zero only when valid status found.
 171     if (!empty($result['id'])) {
 172       $result['is_error'] = 0;
 173     }
 174   }
 175   else {
 176     throw new API_Exception('did not find a membership record');
 177   }
 178   return $result;
 179 }
 180
 181 /**
 182  * Adjust Metadata for Calc action.
 183  *
 184  * The metadata is used for setting defaults, documentation & validation.
 185  *
 186  * @param array $params
 187  *   Array of parameters determined by getfields.
 188  */
 189 function _civicrm_api3_membership_status_calc_spec(&$params) {
 190   $params['membership_id']['api.required'] = 1;
 191   $params['membership_id']['title'] = 'Membership ID';
 192 }