api/v3/MembershipType.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   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 type functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Membership
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: MembershipType.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * API to Create or update a Membership Type
  42  *
  43  * @param   array  $params  an associative array of name/value property values of civicrm_membership_type
  44  *
  45  * @return array $result newly created or updated membership type property values.
  46  * @access public
  47  * {getfields MembershipType_get}
  48  */
  49 function civicrm_api3_membership_type_create($params) {
  50
  51   $values = $params;
  52   civicrm_api3_verify_mandatory($values, 'CRM_Member_DAO_MembershipType');
  53
  54   $ids['membershipType'] = CRM_Utils_Array::value('id', $values);
  55   $ids['memberOfContact'] = CRM_Utils_Array::value('member_of_contact_id', $values);
  56   $ids['contributionType'] = CRM_Utils_Array::value('financial_type_id', $values);
  57
  58   $membershipTypeBAO = CRM_Member_BAO_MembershipType::add($values, $ids);
  59   $membershipType = array();
  60   _civicrm_api3_object_to_array($membershipTypeBAO, $membershipType[$membershipTypeBAO->id]);
  61   CRM_Member_PseudoConstant::membershipType(NULL, TRUE);
  62   return civicrm_api3_create_success($membershipType, $params, 'membership_type', 'create', $membershipTypeBAO);
  63 }
  64
  65 /**
  66  * Adjust Metadata for Create action
  67  *
  68  * The metadata is used for setting defaults, documentation & validation
  69  * @param array $params array or parameters determined by getfields
  70  */
  71 function _civicrm_api3_membership_type_create_spec(&$params) {
  72   // todo could set default here probably
  73   $params['domain_id']['api.required'] = 1;
  74   $params['member_of_contact_id']['api.required'] = 1;
  75   $params['financial_type_id']['api.required'] =1;
  76   $params['name']['api.required'] = 1;
  77   $params['duration_unit']['api.required'] = 1;
  78   $params['duration_interval']['api.required'] = 1;
  79 }
  80
  81 /**
  82  * Get a Membership Type.
  83  *
  84  * This api is used for finding an existing membership type.
  85  *
  86  * @param  array $params  an associative array of name/value property values of civicrm_membership_type
  87  * {getfields MembershipType_get}
  88  *
  89  * @return  Array of all found membership type property values.
  90  * @access public
  91  */
  92 function civicrm_api3_membership_type_get($params) {
  93
  94   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95 }
  96
  97 /**
  98  * Deletes an existing membership type
  99  *
 100  * This API is used for deleting a membership type
 101  * Required parrmeters : id of a membership type
 102  *
 103  * @param  Array   $params  an associative array of name/value property values of civicrm_membership_type
 104  *
 105  * @return boolean        true if success, else false
 106  * @access public
 107  * {getfields MembershipType_delete}
 108  */
 109 function civicrm_api3_membership_type_delete($params) {
 110
 111
 112   $memberDelete = CRM_Member_BAO_MembershipType::del($params['id'], 1);
 113   return $memberDelete ? civicrm_api3_create_success($memberDelete) : civicrm_api3_create_error('Error while deleting membership type. id : ' . $params['id']);
 114 }
 115