3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 membership type functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Membership
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: MembershipBlock.php 30171 2010-10-14 09:11:27Z mover $
40 * API to Create or update a Membership Type
42 * @param array $params
43 * An associative array of name/value property values of civicrm_membership_block.
46 * newly created or updated membership type property values.
48 function civicrm_api3_membership_block_create($params) {
49 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
53 * Adjust Metadata for Create action
55 * The metadata is used for setting defaults, documentation & validation
56 * @param array $params
57 * 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
71 * An associative array of name/value property values of civicrm_membership_block.
72 * {getfields MembershipBlock_get}
75 * api result array of all found membership block property values.
77 function civicrm_api3_membership_block_get($params) {
78 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
82 * Deletes an existing membership type
84 * This API is used for deleting a membership type
85 * Required parameters : id of a membership type
87 * @param array $params
92 function civicrm_api3_membership_block_delete($params) {
93 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);