Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | /** | |
b081365f CW |
29 | * This api exposes CiviCRM contact types and sub-types. |
30 | * | |
31 | * CiviCRM comes with 3 primary contact types - Individual, Organization & Household. | |
32 | * Changing these is not advised, but sub_types can be created with this api. | |
33 | * Pass 'parent_id' param to specify which base type a new sub_type extends. | |
6a488035 TO |
34 | * |
35 | * @package CiviCRM_APIv3 | |
6a488035 TO |
36 | */ |
37 | ||
6a488035 | 38 | /** |
244bbdd8 | 39 | * Create/update ContactType. |
6a488035 | 40 | * |
244bbdd8 CW |
41 | * This API is used to create new ContactType or update any of the existing |
42 | * In case of updating existing ContactType, id of that particular ContactType must | |
6a488035 TO |
43 | * be in $params array. |
44 | * | |
cf470720 | 45 | * @param array $params |
2e66abf8 | 46 | * Array per getfields metadata. |
6a488035 | 47 | * |
a6c01b45 | 48 | * @return array |
244bbdd8 | 49 | * ContactType array |
6a488035 TO |
50 | */ |
51 | function civicrm_api3_contact_type_create($params) { | |
6a488035 | 52 | civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name', 'parent_id')); |
0f77a625 | 53 | |
54 | if (empty($params['id'])) { | |
55 | if (!array_key_exists('label', $params)) { | |
56 | $params['label'] = $params['name']; | |
57 | } | |
58 | if (!array_key_exists('is_active', $params)) { | |
59 | $params['is_active'] = TRUE; | |
60 | } | |
61 | $params['name'] = CRM_Utils_String::munge($params['name']); | |
6a488035 TO |
62 | } |
63 | ||
6a488035 TO |
64 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
65 | } | |
66 | ||
67 | /** | |
c28e1768 | 68 | * Returns array of contact_types matching a set of one or more properties. |
6a488035 | 69 | * |
cf470720 | 70 | * @param array $params |
c28e1768 CW |
71 | * One or more valid property_name=>value pairs. |
72 | * If $params is set as null, all contact_types will be returned | |
6a488035 | 73 | * |
a6c01b45 | 74 | * @return array |
72b3a70c | 75 | * Array of matching contact_types |
6a488035 TO |
76 | */ |
77 | function civicrm_api3_contact_type_get($params) { | |
78 | civicrm_api3_verify_mandatory($params); | |
79 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
80 | } | |
81 | ||
82 | /** | |
244bbdd8 | 83 | * Delete an existing ContactType. |
6a488035 | 84 | * |
244bbdd8 | 85 | * This method is used to delete any existing ContactType given its id. |
6a488035 | 86 | * |
cf470720 | 87 | * @param array $params |
c28e1768 | 88 | * [id] |
6a488035 | 89 | * |
a6c01b45 | 90 | * @return array |
72b3a70c | 91 | * API Result Array |
6a488035 TO |
92 | */ |
93 | function civicrm_api3_contact_type_delete($params) { | |
94 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
95 | } |