api/v3/MembershipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 membership type functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Membership
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: MembershipType.php 30171 2010-10-14 09:11:27Z mover $
  36  *
  37  */
  38
  39 /**
  40  * API to Create or update a Membership Type
  41  *
  42  * @param array $params
  43  *   An associative array of name/value property values of civicrm_membership_type.
  44  *
  45  * @return array
  46  *   newly created or updated membership type property values.
  47  */
  48 function civicrm_api3_membership_type_create($params) {
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Membership_type');
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action
  54  *
  55  * The metadata is used for setting defaults, documentation & validation
  56  * @param array $params
  57  *   Array or parameters determined by getfields.
  58  */
  59 function _civicrm_api3_membership_type_create_spec(&$params) {
  60   // todo could set default here probably
  61   $params['domain_id']['api.required'] = 1;
  62   $params['member_of_contact_id']['api.required'] = 1;
  63   $params['financial_type_id']['api.required'] = 1;
  64   $params['name']['api.required'] = 1;
  65   $params['duration_unit']['api.required'] = 1;
  66   $params['duration_interval']['api.required'] = 1;
  67 }
  68
  69 /**
  70  * Get a Membership Type.
  71  *
  72  * This api is used for finding an existing membership type.
  73  *
  74  * @param array $params
  75  *   An associative array of name/value property values of civicrm_membership_type.
  76  * {getfields MembershipType_get}
  77  *
  78  * @return array
  79  *   Array of all found membership type property values.
  80  */
  81 function civicrm_api3_membership_type_get($params) {
  82   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  83 }
  84
  85 /**
  86  * Deletes an existing membership type
  87  *
  88  * This API is used for deleting a membership type
  89  * Required parameters : id of a membership type
  90  *
  91  * @param array $params
  92  *
  93  * @return bool
  94  *   true if success, else false
  95  */
  96 function civicrm_api3_membership_type_delete($params) {
  97   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }