Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | * File for the CiviCRM APIv3 group functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Survey | |
731a0992 | 33 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
34 | */ |
35 | ||
6a488035 | 36 | /** |
9d32e6f7 | 37 | * Create/update contact_type. |
6a488035 TO |
38 | * |
39 | * This API is used to create new contact_type or update any of the existing | |
40 | * In case of updating existing contact_type, id of that particular contact_type must | |
41 | * be in $params array. | |
42 | * | |
cf470720 | 43 | * @param array $params |
2e66abf8 | 44 | * Array per getfields metadata. |
6a488035 | 45 | * |
a6c01b45 | 46 | * @return array |
72b3a70c | 47 | * contact_type array |
6a488035 TO |
48 | */ |
49 | function civicrm_api3_contact_type_create($params) { | |
6a488035 | 50 | civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name', 'parent_id')); |
0f77a625 | 51 | |
52 | if (empty($params['id'])) { | |
53 | if (!array_key_exists('label', $params)) { | |
54 | $params['label'] = $params['name']; | |
55 | } | |
56 | if (!array_key_exists('is_active', $params)) { | |
57 | $params['is_active'] = TRUE; | |
58 | } | |
59 | $params['name'] = CRM_Utils_String::munge($params['name']); | |
6a488035 TO |
60 | } |
61 | ||
6a488035 TO |
62 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
63 | } | |
64 | ||
65 | /** | |
9d32e6f7 | 66 | * Returns array of contact_types matching a set of one or more group properties. |
6a488035 | 67 | * |
cf470720 TO |
68 | * @param array $params |
69 | * One or more valid. | |
6a488035 TO |
70 | * property_name=>value pairs. If $params is set |
71 | * as null, all contact_types will be returned | |
72 | * | |
a6c01b45 | 73 | * @return array |
72b3a70c | 74 | * Array of matching contact_types |
6a488035 TO |
75 | */ |
76 | function civicrm_api3_contact_type_get($params) { | |
77 | civicrm_api3_verify_mandatory($params); | |
78 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
79 | } | |
80 | ||
81 | /** | |
9d32e6f7 | 82 | * Delete an existing contact_type. |
6a488035 TO |
83 | * |
84 | * This method is used to delete any existing contact_type. id of the group | |
85 | * to be deleted is required field in $params array | |
86 | * | |
cf470720 TO |
87 | * @param array $params |
88 | * Array containing id of the group. | |
6a488035 TO |
89 | * to be deleted |
90 | * | |
a6c01b45 | 91 | * @return array |
72b3a70c | 92 | * API Result Array |
6a488035 TO |
93 | */ |
94 | function civicrm_api3_contact_type_delete($params) { | |
95 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
96 | } |