Commit | Line | Data |
---|---|---|
7f254ad8 AE |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.6 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2015 | | |
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 | * This api exposes CiviCRM MembershipBlock records. | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | */ | |
33 | ||
34 | /** | |
35 | * API to Create or update a MembershipBlock. | |
36 | * | |
37 | * @param array $params | |
38 | * An associative array of name/value property values of MembershipBlock. | |
39 | * | |
40 | * @return array | |
41 | * newly created or updated membership block property values. | |
42 | */ | |
43 | function civicrm_api3_membership_block_create($params) { | |
44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
45 | } | |
46 | ||
47 | /** | |
48 | * Adjust Metadata for Create action. | |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
51 | * | |
52 | * @param array $params | |
53 | * Array of parameters determined by getfields. | |
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 | /** | |
62 | * Get a Membership Block. | |
63 | * | |
64 | * This api is used for finding an existing membership block. | |
65 | * | |
66 | * @param array $params | |
67 | * An associative array of name/value property values of civicrm_membership_block. | |
68 | * {getfields MembershipBlock_get} | |
69 | * | |
70 | * @return array | |
71 | * api result array of all found membership block property values. | |
72 | */ | |
73 | function civicrm_api3_membership_block_get($params) { | |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
75 | } | |
76 | ||
77 | /** | |
78 | * Deletes an existing membership block. | |
79 | * | |
80 | * This API is used for deleting a membership block | |
81 | * Required parameters : id of a membership block | |
82 | * | |
83 | * @param array $params | |
84 | * | |
85 | * @return array | |
86 | * api result array | |
87 | */ | |
88 | function civicrm_api3_membership_block_delete($params) { | |
89 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
90 | } |