4ff927bc |
1 | <?php |
2 | /* |
3 | +--------------------------------------------------------------------+ |
81621fee |
4 | | CiviCRM version 4.7 | |
4ff927bc |
5 | +--------------------------------------------------------------------+ |
1f4ea726 |
6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
4ff927bc |
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 MembershipLog records. |
30 | * |
31 | * @package CiviCRM_APIv3 |
32 | */ |
33 | |
34 | /** |
35 | * API to Create or update a MembershipLog. |
36 | * |
37 | * @param array $params |
38 | * Values of MembershipLog. |
39 | * |
40 | * @return array |
41 | * API result array. |
42 | */ |
43 | function civicrm_api3_membership_log_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_log_create_spec(&$params) { |
56 | $params['membership_id']['api.required'] = TRUE; |
57 | } |
58 | |
59 | /** |
60 | * Get a Membership Log. |
61 | * |
62 | * This api is used for finding an existing membership log. |
63 | * |
64 | * @param array $params |
65 | * An associative array of name/value property values of civicrm_membership_log. |
66 | * {getfields MembershipLog_get} |
67 | * |
68 | * @return array |
69 | * API result array |
70 | */ |
71 | function civicrm_api3_membership_log_get($params) { |
72 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
73 | } |
74 | |
75 | /** |
76 | * Deletes an existing membership log. |
77 | * |
78 | * This API is used for deleting a membership log |
79 | * Required parameters : id of a membership log |
80 | * |
81 | * @param array $params |
82 | * |
83 | * @return array |
84 | * API result array |
85 | */ |
86 | function civicrm_api3_membership_log_delete($params) { |
87 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
88 | } |