api/v3/ContactType.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  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  *
  44  * @param array $params  (referance) Associative array of property
  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) {
  52   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name', 'parent_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
  60   $params['name'] = CRM_Utils_String::munge($params['name']);
  61   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  62 }
  63
  64 /**
  65  * Returns array of contact_types  matching a set of one or more group properties
  66  *
  67  * @param array $params  (referance) Array of one or more valid
  68  *                       property_name=>value pairs. If $params is set
  69  *                       as null, all contact_types will be returned
  70  *
  71  * @return array  (referance) Array of matching contact_types
  72  * @access public
  73  */
  74 function civicrm_api3_contact_type_get($params) {
  75   civicrm_api3_verify_mandatory($params);
  76   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  77 }
  78
  79 /**
  80  * delete an existing contact_type
  81  *
  82  * This method is used to delete any existing contact_type. id of the group
  83  * to be deleted is required field in $params array
  84  *
  85  * @param array $params  (reference) array containing id of the group
  86  *                       to be deleted
  87  *
  88  * @return array  (referance) returns flag true if successfull, error
  89  *                message otherwise
  90  *
  91  * @access public
  92  */
  93 function civicrm_api3_contact_type_delete($params) {
  94   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95 }
  96