api/v3/RelationshipType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 relationship types.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create relationship type.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @return array
  41  */
  42 function civicrm_api3_relationship_type_create($params) {
  43
  44   if (!isset($params['label_a_b'])) {
  45
  46     $params['label_a_b'] = $params['name_a_b'];
  47   }
  48
  49   if (!isset($params['label_b_a'])) {
  50
  51     $params['label_b_a'] = $params['name_b_a'];
  52   }
  53
  54   $ids = array();
  55   if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
  56     return civicrm_api3_create_error('Invalid value for relationship type ID');
  57   }
  58   else {
  59     $ids['relationshipType'] = CRM_Utils_Array::value('id', $params);
  60   }
  61
  62   $relationType = CRM_Contact_BAO_RelationshipType::add($params, $ids);
  63
  64   $relType = array();
  65
  66   _civicrm_api3_object_to_array($relationType, $relType[$relationType->id]);
  67
  68   return civicrm_api3_create_success($relType, $params, 'RelationshipType', 'create', $relationType);
  69 }
  70
  71 /**
  72  * Adjust Metadata for Create action.
  73  *
  74  * The metadata is used for setting defaults, documentation & validation.
  75  *
  76  * @param array $params
  77  *   Array of parameters determined by getfields.
  78  */
  79 function _civicrm_api3_relationship_type_create_spec(&$params) {
  80   $params['contact_type_a']['api.required'] = 1;
  81   $params['contact_type_b']['api.required'] = 1;
  82   $params['name_a_b']['api.required'] = 1;
  83   $params['name_b_a']['api.required'] = 1;
  84   $params['is_active']['api.default'] = 1;
  85 }
  86
  87 /**
  88  * Get all relationship types.
  89  *
  90  * @param array $params
  91  *
  92  * @return array
  93  */
  94 function civicrm_api3_relationship_type_get($params) {
  95   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  96 }
  97
  98 /**
  99  * Delete a relationship type.
 100  *
 101  * @param array $params
 102  *
 103  * @return array
 104  *   API Result Array
 105  */
 106 function civicrm_api3_relationship_type_delete($params) {
 107   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 108 }
 109
 110 /**
 111  * Get list defaults for relationship types.
 112  *
 113  * @see _civicrm_api3_generic_getlist_defaults
 114  *
 115  * @param array $request
 116  *
 117  * @return array
 118  */
 119 function _civicrm_api3_relationship_type_getlist_defaults($request) {
 120   return array(
 121     'label_field' => 'label_a_b',
 122     'search_field' => 'label_a_b',
 123   );
 124 }