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 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM MembershipBlock records. |
f64a217a EM |
30 | * |
31 | * @package CiviCRM_APIv3 | |
f64a217a EM |
32 | */ |
33 | ||
34 | /** | |
244bbdd8 | 35 | * API to Create or update a MembershipBlock. |
f64a217a | 36 | * |
37fa58b0 | 37 | * @param array $params |
244bbdd8 | 38 | * An associative array of name/value property values of MembershipBlock. |
f64a217a | 39 | * |
a6c01b45 | 40 | * @return array |
c28e1768 | 41 | * newly created or updated membership block property values. |
f64a217a EM |
42 | */ |
43 | function civicrm_api3_membership_block_create($params) { | |
44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
45 | } | |
46 | ||
47 | /** | |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
f64a217a | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
f64a217a EM |
54 | */ |
55 | function _civicrm_api3_membership_block_create_spec(&$params) { | |
56 | $params['is_active']['api.default'] = TRUE; | |
57 | $params['entity_id']['api.required'] = TRUE; | |
58 | $params['entity_table']['api.default'] = 'civicrm_contribution_page'; | |
59 | } | |
60 | ||
61 | /** | |
c28e1768 | 62 | * Get a Membership Block. |
f64a217a | 63 | * |
c28e1768 | 64 | * This api is used for finding an existing membership block. |
f64a217a | 65 | * |
cf470720 TO |
66 | * @param array $params |
67 | * An associative array of name/value property values of civicrm_membership_block. | |
f64a217a EM |
68 | * {getfields MembershipBlock_get} |
69 | * | |
a6c01b45 | 70 | * @return array |
72b3a70c | 71 | * api result array of all found membership block property values. |
f64a217a EM |
72 | */ |
73 | function civicrm_api3_membership_block_get($params) { | |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
75 | } | |
76 | ||
77 | /** | |
c28e1768 | 78 | * Deletes an existing membership block. |
f64a217a | 79 | * |
c28e1768 CW |
80 | * This API is used for deleting a membership block |
81 | * Required parameters : id of a membership block | |
f64a217a | 82 | * |
cf470720 | 83 | * @param array $params |
f64a217a | 84 | * |
a6c01b45 | 85 | * @return array |
72b3a70c | 86 | * api result array |
f64a217a EM |
87 | */ |
88 | function civicrm_api3_membership_block_delete($params) { | |
89 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
90 | } |