Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 group functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Survey | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | */ |
36 | ||
6a488035 TO |
37 | /** |
38 | * create/update contact_type | |
39 | * | |
40 | * This API is used to create new contact_type or update any of the existing | |
41 | * In case of updating existing contact_type, id of that particular contact_type must | |
42 | * be in $params array. | |
43 | * | |
c206647d | 44 | * @param array $params (reference) Associative array of property |
6a488035 TO |
45 | * name/value pairs to insert in new 'contact_type' |
46 | * | |
47 | * @return array contact_type array | |
48 | * | |
49 | * @access public | |
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 | /** | |
68 | * Returns array of contact_types matching a set of one or more group properties | |
69 | * | |
c206647d | 70 | * @param array $params one or more valid |
6a488035 TO |
71 | * property_name=>value pairs. If $params is set |
72 | * as null, all contact_types will be returned | |
73 | * | |
c206647d | 74 | * @return array Array of matching contact_types |
6a488035 TO |
75 | * @access public |
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 | /** | |
83 | * delete an existing contact_type | |
84 | * | |
85 | * This method is used to delete any existing contact_type. id of the group | |
86 | * to be deleted is required field in $params array | |
87 | * | |
c206647d | 88 | * @param array $params array containing id of the group |
6a488035 TO |
89 | * to be deleted |
90 | * | |
c206647d | 91 | * @return array API Result Array |
6a488035 TO |
92 | * |
93 | * @access public | |
94 | */ | |
95 | function civicrm_api3_contact_type_delete($params) { | |
96 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
97 | } | |
98 |