Commit | Line | Data |
---|---|---|
f64a217a | 1 | <?php |
f64a217a EM |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
f64a217a EM |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
f64a217a EM |
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: MembershipBlock.php 30171 2010-10-14 09:11:27Z mover $ | |
36 | * | |
37 | */ | |
38 | ||
39 | /** | |
40 | * API to Create or update a Membership Type | |
41 | * | |
37fa58b0 | 42 | * @param array $params |
cf470720 | 43 | * An associative array of name/value property values of civicrm_membership_block. |
f64a217a | 44 | * |
a6c01b45 | 45 | * @return array |
72b3a70c | 46 | * newly created or updated membership type property values. |
f64a217a EM |
47 | */ |
48 | function civicrm_api3_membership_block_create($params) { | |
49 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
50 | } | |
51 | ||
52 | /** | |
53 | * Adjust Metadata for Create action | |
54 | * | |
55 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
56 | * @param array $params |
57 | * Array or parameters determined by getfields. | |
f64a217a EM |
58 | */ |
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'; | |
63 | } | |
64 | ||
65 | /** | |
66 | * Get a Membership Type. | |
67 | * | |
68 | * This api is used for finding an existing membership type. | |
69 | * | |
cf470720 TO |
70 | * @param array $params |
71 | * An associative array of name/value property values of civicrm_membership_block. | |
f64a217a EM |
72 | * {getfields MembershipBlock_get} |
73 | * | |
a6c01b45 | 74 | * @return array |
72b3a70c | 75 | * api result array of all found membership block property values. |
f64a217a EM |
76 | */ |
77 | function civicrm_api3_membership_block_get($params) { | |
78 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
79 | } | |
80 | ||
81 | /** | |
82 | * Deletes an existing membership type | |
83 | * | |
84 | * This API is used for deleting a membership type | |
85 | * Required parameters : id of a membership type | |
86 | * | |
cf470720 | 87 | * @param array $params |
f64a217a | 88 | * |
a6c01b45 | 89 | * @return array |
72b3a70c | 90 | * api result array |
f64a217a EM |
91 | */ |
92 | function civicrm_api3_membership_block_delete($params) { | |
93 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } |