api/v3/ContactType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * 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.
  34  *
  35  * @package CiviCRM_APIv3
  36  */
  37
  38 /**
  39  * Create/update ContactType.
  40  *
  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
  43  * be in $params array.
  44  *
  45  * @param array $params
  46  *   Array per getfields metadata.
  47  *
  48  * @return array
  49  *   ContactType array
  50  */
  51 function civicrm_api3_contact_type_create($params) {
  52   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), ['name', 'parent_id']);
  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']);
  62   }
  63
  64   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContactType');
  65 }
  66
  67 /**
  68  * Returns array of contact_types matching a set of one or more properties.
  69  *
  70  * @param array $params
  71  *   One or more valid property_name=>value pairs.
  72  *   If $params is set as null, all contact_types will be returned
  73  *
  74  * @return array
  75  *   Array of matching contact_types
  76  */
  77 function civicrm_api3_contact_type_get($params) {
  78   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  79 }
  80
  81 /**
  82  * Delete an existing ContactType.
  83  *
  84  * This method is used to delete any existing ContactType given its id.
  85  *
  86  * @param array $params
  87  *   [id]
  88  *
  89  * @return array
  90  *   API Result Array
  91  */
  92 function civicrm_api3_contact_type_delete($params) {
  93   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  94 }