5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Survey
35 * @copyright CiviCRM LLC (c) 2004-2013
38 //require_once 'CRM/Campaign/BAO/ContactType.php';
39 require_once 'api/v3/utils.php';
42 * create/update contact_type
44 * This API is used to create new contact_type or update any of the existing
45 * In case of updating existing contact_type, id of that particular contact_type must
46 * be in $params array.
48 * @param array $params (referance) Associative array of property
49 * name/value pairs to insert in new 'contact_type'
51 * @return array contact_type array
55 function civicrm_api3_contact_type_create($params) {
56 require_once 'CRM/Utils/String.php';
57 civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__
), array('name', 'parent_id'));
58 if (!array_key_exists('label', $params)) {
59 $params['label'] = $params['name'];
61 if (!array_key_exists('is_active', $params)) {
62 $params['is_active'] = TRUE;
65 $params['name'] = CRM_Utils_String
::munge($params['name']);
66 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
70 * Returns array of contact_types matching a set of one or more group properties
72 * @param array $params (referance) Array of one or more valid
73 * property_name=>value pairs. If $params is set
74 * as null, all contact_types will be returned
76 * @return array (referance) Array of matching contact_types
79 function civicrm_api3_contact_type_get($params) {
80 civicrm_api3_verify_mandatory($params);
81 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
85 * delete an existing contact_type
87 * This method is used to delete any existing contact_type. id of the group
88 * to be deleted is required field in $params array
90 * @param array $params (reference) array containing id of the group
93 * @return array (referance) returns flag true if successfull, error
98 function civicrm_api3_contact_type_delete($params) {
99 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);