api/v3/MembershipStatus.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.4                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 membership status functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Membership
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: MembershipStatus.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * Create a Membership Status
  42  *
  43  * This API is used for creating a Membership Status
  44  *
  45  * @param   array  $params  an associative array of name/value property values of civicrm_membership_status
  46  *
  47  * @return array of newly created membership status property values.
  48  * {@getfields MembershipStatus_create}
  49  * @access public
  50  */
  51 function civicrm_api3_membership_status_create($params) {
  52   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  53 }
  54
  55 /**
  56  * Adjust Metadata for Create action
  57  *
  58  * The metadata is used for setting defaults, documentation & validation
  59  * @param array $params array or parameters determined by getfields
  60  */
  61 function _civicrm_api3_membership_status_create_spec(&$params) {
  62   $params['name']['api.aliases'] = array('label');
  63 }
  64
  65 /**
  66  * Get a membership status.
  67  *
  68  * This api is used for finding an existing membership status.
  69  *
  70  * @param  array $params  an associative array of name/value property values of civicrm_membership_status
  71  *
  72  * @return  Array of all found membership status property values.
  73  * {@getfields MembershipStatus_get}
  74  * @access public
  75  */
  76 function civicrm_api3_membership_status_get($params) {
  77   return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params);
  78 }
  79
  80 /**
  81  * Update an existing membership status
  82  *
  83  * This api is used for updating an existing membership status.
  84  * Required parrmeters : id of a membership status
  85  *
  86  * @param  Array   $params  an associative array of name/value property values of civicrm_membership_status
  87  * @deprecated - should just use create
  88  *
  89  * @return array of updated membership status property values
  90  * @access public
  91  */
  92 function &civicrm_api3_membership_status_update($params) {
  93
  94   civicrm_api3_verify_mandatory($params, NULL, array('id'));
  95   //don't allow duplicate names.
  96   $name = CRM_Utils_Array::value('name', $params);
  97   if ($name) {
  98     $status = new CRM_Member_DAO_MembershipStatus();
  99     $status->name = $params['name'];
 100     if ($status->find(TRUE) && $status->id != $params['id']) {
 101       return civicrm_api3_create_error(ts('A membership status with this name already exists.'));
 102     }
 103   }
 104
 105   $membershipStatusBAO = new CRM_Member_BAO_MembershipStatus();
 106   $membershipStatusBAO->id = $params['id'];
 107   if ($membershipStatusBAO->find(TRUE)) {
 108     $fields = $membershipStatusBAO->fields();
 109     foreach ($fields as $name => $field) {
 110       if (array_key_exists($name, $params)) {
 111         $membershipStatusBAO->$name = $params[$name];
 112       }
 113     }
 114     $membershipStatusBAO->save();
 115   }
 116   $membershipStatus = array();
 117   _civicrm_api3_object_to_array(clone($membershipStatusBAO), $membershipStatus);
 118   $membershipStatus['is_error'] = 0;
 119   return $membershipStatus;
 120 }
 121
 122 /**
 123  * Deletes an existing membership status
 124  *
 125  * This API is used for deleting a membership status
 126  *
 127  * @param  array  Params array containing 'id' -    Id of the membership status to be deleted
 128  * {@getfields MembershipStatus_delete}
 129  *
 130  * @return array i
 131  * @access public
 132  */
 133 function civicrm_api3_membership_status_delete($params) {
 134
 135   $memberStatusDelete = CRM_Member_BAO_MembershipStatus::del($params['id'], TRUE);
 136   return $memberStatusDelete ? civicrm_api3_create_error($memberStatusDelete['error_message']) : civicrm_api3_create_success();
 137 }
 138
 139 /**
 140  * Derives the Membership Status of a given Membership Reocrd
 141  *
 142  * This API is used for deriving Membership Status of a given Membership
 143  * record using the rules encoded in the membership_status table.
 144  *
 145  * @param  Int     $membershipID  Id of a membership
 146  * @param  String  $statusDate
 147  *
 148  * @return Array  Array of status id and status name
 149  * @public
 150  */
 151 function civicrm_api3_membership_status_calc($membershipParams) {
 152
 153   if (!($membershipID = CRM_Utils_Array::value('membership_id', $membershipParams))) {
 154     return civicrm_api3_create_error('membershipParams do not contain membership_id');
 155   }
 156
 157   $query = "
 158 SELECT start_date, end_date, join_date
 159   FROM civicrm_membership
 160  WHERE id = %1
 161 ";
 162
 163   $params = array(1 => array($membershipID, 'Integer'));
 164   $dao = &CRM_Core_DAO::executeQuery($query, $params);
 165   if ($dao->fetch()) {
 166     // Take the is_admin column in MembershipStatus into consideration when requested
 167     if (! CRM_Utils_Array::value('ignore_admin_only', $membershipParams) ) {
 168       $result = &CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dao->start_date, $dao->end_date, $dao->join_date, 'today', TRUE);
 169     }
 170     else {
 171     $result = &CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dao->start_date, $dao->end_date, $dao->join_date);
 172     }
 173
 174     //make is error zero only when valid status found.
 175     if (CRM_Utils_Array::value('id', $result)) {
 176       $result['is_error'] = 0;
 177     }
 178   }
 179   else {
 180     $result = civicrm_api3_create_error('did not find a membership record');
 181   }
 182   $dao->free();
 183   return $result;
 184 }
 185