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