api/v3/MembershipType.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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
  44  *   An associative array of name/value property values of civicrm_membership_type.
  45  *
  46  * @return array
  47  *   newly created or updated membership type property values.
  48  * @access public
  49  * {getfields MembershipType_get}
  50  */
  51 function civicrm_api3_membership_type_create($params) {
  52   $ids['membershipType'] = CRM_Utils_Array::value('id', $params);
  53   $ids['memberOfContact'] = CRM_Utils_Array::value('member_of_contact_id', $params);
  54   $ids['contributionType'] = CRM_Utils_Array::value('financial_type_id', $params);
  55
  56   $membershipTypeBAO = CRM_Member_BAO_MembershipType::add($params, $ids);
  57   $membershipType = array();
  58   _civicrm_api3_object_to_array($membershipTypeBAO, $membershipType[$membershipTypeBAO->id]);
  59   CRM_Member_PseudoConstant::membershipType(NULL, TRUE);
  60   civicrm_api3('membership', 'getfields', array('cache_clear' => 1, 'fieldname' => 'membership_type_id'));
  61   civicrm_api3('profile', 'getfields', array('action' => 'submit', 'cache_clear' => 1));
  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
  70  *   Array or parameters determined by getfields.
  71  */
  72 function _civicrm_api3_membership_type_create_spec(&$params) {
  73   // todo could set default here probably
  74   $params['domain_id']['api.required'] = 1;
  75   $params['member_of_contact_id']['api.required'] = 1;
  76   $params['financial_type_id']['api.required'] = 1;
  77   $params['name']['api.required'] = 1;
  78   $params['duration_unit']['api.required'] = 1;
  79   $params['duration_interval']['api.required'] = 1;
  80 }
  81
  82 /**
  83  * Get a Membership Type.
  84  *
  85  * This api is used for finding an existing membership type.
  86  *
  87  * @param array $params
  88  *   An associative array of name/value property values of civicrm_membership_type.
  89  * {getfields MembershipType_get}
  90  *
  91  * @return array
  92  *   Array of all found membership type property values.
  93  * @access public
  94  */
  95 function civicrm_api3_membership_type_get($params) {
  96   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  97 }
  98
  99 /**
 100  * Deletes an existing membership type
 101  *
 102  * This API is used for deleting a membership type
 103  * Required parameters : id of a membership type
 104  *
 105  * @param array $params
 106  *
 107  * @return boolean
 108  *   true if success, else false
 109  * @access public
 110  * {getfields MembershipType_delete}
 111  */
 112 function civicrm_api3_membership_type_delete($params) {
 113   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 114 }