Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 membership type functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Membership | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: MembershipType.php 30171 2010-10-14 09:11:27Z mover $ | |
38 | * | |
39 | */ | |
40 | ||
6a488035 TO |
41 | /** |
42 | * API to Create or update a Membership Type | |
43 | * | |
44 | * @param array $params an associative array of name/value property values of civicrm_membership_type | |
45 | * | |
46 | * @return array $result newly created or updated membership type property values. | |
47 | * @access public | |
48 | * {getfields MembershipType_get} | |
49 | */ | |
50 | function civicrm_api3_membership_type_create($params) { | |
51 | ||
52 | $values = $params; | |
53 | civicrm_api3_verify_mandatory($values, 'CRM_Member_DAO_MembershipType'); | |
54 | ||
55 | $ids['membershipType'] = CRM_Utils_Array::value('id', $values); | |
56 | $ids['memberOfContact'] = CRM_Utils_Array::value('member_of_contact_id', $values); | |
57 | $ids['contributionType'] = CRM_Utils_Array::value('financial_type_id', $values); | |
58 | ||
6a488035 TO |
59 | $membershipTypeBAO = CRM_Member_BAO_MembershipType::add($values, $ids); |
60 | $membershipType = array(); | |
61 | _civicrm_api3_object_to_array($membershipTypeBAO, $membershipType[$membershipTypeBAO->id]); | |
62 | CRM_Member_PseudoConstant::membershipType(NULL, TRUE); | |
63 | return civicrm_api3_create_success($membershipType, $params, 'membership_type', 'create', $membershipTypeBAO); | |
64 | } | |
11e09c59 TO |
65 | |
66 | /** | |
6a488035 TO |
67 | * Adjust Metadata for Create action |
68 | * | |
69 | * The metadata is used for setting defaults, documentation & validation | |
70 | * @param array $params array or parameters determined by getfields | |
71 | */ | |
72 | function _civicrm_api3_membership_type_create_spec(&$params) { | |
73 | // todo could set default here probably | |
74 | $params['domain_id']['api.required'] = 1; | |
75 | $params['member_of_contact_id']['api.required'] = 1; | |
76 | $params['financial_type_id']['api.required'] =1; | |
77 | $params['name']['api.required'] = 1; | |
78 | $params['duration_unit']['api.required'] = 1; | |
79 | $params['duration_interval']['api.required'] = 1; | |
80 | } | |
81 | ||
82 | /** | |
83 | * Get a Membership Type. | |
84 | * | |
85 | * This api is used for finding an existing membership type. | |
86 | * | |
87 | * @param array $params an associative array of name/value property values of civicrm_membership_type | |
88 | * {getfields MembershipType_get} | |
89 | * | |
90 | * @return Array of all found membership type property values. | |
91 | * @access public | |
92 | */ | |
93 | function civicrm_api3_membership_type_get($params) { | |
94 | ||
95 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
96 | } | |
97 | ||
98 | /** | |
99 | * Deletes an existing membership type | |
100 | * | |
101 | * This API is used for deleting a membership type | |
102 | * Required parrmeters : id of a membership type | |
103 | * | |
104 | * @param Array $params an associative array of name/value property values of civicrm_membership_type | |
105 | * | |
106 | * @return boolean true if success, else false | |
107 | * @access public | |
108 | * {getfields MembershipType_delete} | |
109 | */ | |
110 | function civicrm_api3_membership_type_delete($params) { | |
111 | ||
112 | ||
113 | $memberDelete = CRM_Member_BAO_MembershipType::del($params['id'], 1); | |
114 | return $memberDelete ? civicrm_api3_create_success($memberDelete) : civicrm_api3_create_error('Error while deleting membership type. id : ' . $params['id']); | |
115 | } | |
116 |