X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FContactType.php;h=6e4567493b064ec003a8d8d0d96e4a71ade4b578;hb=b0a317143b2c1a6aee3b6bc99ef31532881f652e;hp=da99127cd9dbca1c8d641d01c5a8b494bfcff4c1;hpb=9ed4c3c05a8b3d0932a18eabe3be878121cb8d19;p=civicrm-core.git

diff --git a/api/v3/ContactType.php b/api/v3/ContactType.php
index da99127cd9..6e4567493b 100644
--- a/api/v3/ContactType.php
+++ b/api/v3/ContactType.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,51 +26,53 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM contact types and sub-types.
+ *
+ * CiviCRM comes with 3 primary contact types - Individual, Organization & Household.
+ * Changing these is not advised, but sub_types can be created with this api.
+ * Pass 'parent_id' param to specify which base type a new sub_type extends.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Survey
- * @copyright CiviCRM LLC (c) 2004-2013
  */
 
-require_once 'api/v3/utils.php';
-
 /**
- * create/update contact_type
+ * Create/update contact_type.
  *
  * This API is used to create new contact_type or update any of the existing
  * In case of updating existing contact_type, id of that particular contact_type must
  * be in $params array.
  *
- * @param array $params  (referance) Associative array of property
- *                       name/value pairs to insert in new 'contact_type'
- *
- * @return array   contact_type array
+ * @param array $params
+ *   Array per getfields metadata.
  *
- * @access public
+ * @return array
+ *   contact_type array
  */
 function civicrm_api3_contact_type_create($params) {
   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name', 'parent_id'));
-  if (!array_key_exists('label', $params)) {
-    $params['label'] = $params['name'];
-  }
-  if (!array_key_exists('is_active', $params)) {
-    $params['is_active'] = TRUE;
+
+  if (empty($params['id'])) {
+    if (!array_key_exists('label', $params)) {
+      $params['label'] = $params['name'];
+    }
+    if (!array_key_exists('is_active', $params)) {
+      $params['is_active'] = TRUE;
+    }
+    $params['name'] = CRM_Utils_String::munge($params['name']);
   }
 
-  $params['name'] = CRM_Utils_String::munge($params['name']);
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Returns array of contact_types  matching a set of one or more group properties
+ * Returns array of contact_types matching a set of one or more properties.
  *
- * @param array $params  (referance) Array of one or more valid
- *                       property_name=>value pairs. If $params is set
- *                       as null, all contact_types will be returned
+ * @param array $params
+ *   One or more valid property_name=>value pairs.
+ *   If $params is set as null, all contact_types will be returned
  *
- * @return array  (referance) Array of matching contact_types
- * @access public
+ * @return array
+ *   Array of matching contact_types
  */
 function civicrm_api3_contact_type_get($params) {
   civicrm_api3_verify_mandatory($params);
@@ -79,20 +80,17 @@ function civicrm_api3_contact_type_get($params) {
 }
 
 /**
- * delete an existing contact_type
+ * Delete an existing contact_type.
  *
  * This method is used to delete any existing contact_type. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
- *                       to be deleted
+ * @param array $params
+ *   [id]
  *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
- *
- * @access public
+ * @return array
+ *   API Result Array
  */
 function civicrm_api3_contact_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-