4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 membership type functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Membership
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: MembershipBlock.php 30171 2010-10-14 09:11:27Z mover $
41 * API to Create or update a Membership Type
43 * @param array$params an associative array of name/value property values of civicrm_membership_block
45 * @return array $result newly created or updated membership type property values.
47 * {getfields MembershipBlock_get}
49 function civicrm_api3_membership_block_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Adjust Metadata for Create action
56 * The metadata is used for setting defaults, documentation & validation
57 * @param array $params array or parameters determined by getfields
59 function _civicrm_api3_membership_block_create_spec(&$params) {
60 $params['is_active']['api.default'] = TRUE;
61 $params['entity_id']['api.required'] = TRUE;
62 $params['entity_table']['api.default'] = 'civicrm_contribution_page';
66 * Get a Membership Type.
68 * This api is used for finding an existing membership type.
70 * @param array $params an associative array of name/value property values of civicrm_membership_block
71 * {getfields MembershipBlock_get}
73 * @return array api result array of all found membership block property values.
76 function civicrm_api3_membership_block_get($params) {
77 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
81 * Deletes an existing membership type
83 * This API is used for deleting a membership type
84 * Required parameters : id of a membership type
86 * @param array $params
88 * @return array api result array
90 * {getfields MembershipBlock_delete}
92 function civicrm_api3_membership_block_delete($params) {
93 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);