api/v3/RelationshipType.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 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   // @todo should we when id is empty?
  45   if (!isset($params['label_a_b']) && !empty($params['name_a_b'])) {
  46     $params['label_a_b'] = $params['name_a_b'];
  47   }
  48
  49   if (!isset($params['label_b_a']) && !empty($params['name_b_a'])) {
  50     $params['label_b_a'] = $params['name_b_a'];
  51   }
  52
  53   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'RelationshipType');
  54 }
  55
  56 /**
  57  * Adjust Metadata for Create action.
  58  *
  59  * The metadata is used for setting defaults, documentation & validation.
  60  *
  61  * @param array $params
  62  *   Array of parameters determined by getfields.
  63  */
  64 function _civicrm_api3_relationship_type_create_spec(&$params) {
  65   $params['name_a_b']['api.required'] = 1;
  66   $params['name_b_a']['api.required'] = 1;
  67   $params['is_active']['api.default'] = 1;
  68 }
  69
  70 /**
  71  * Get all relationship types.
  72  *
  73  * @param array $params
  74  *
  75  * @return array
  76  */
  77 function civicrm_api3_relationship_type_get($params) {
  78   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  79 }
  80
  81 /**
  82  * Delete a relationship type.
  83  *
  84  * @param array $params
  85  *
  86  * @return array
  87  *   API Result Array
  88  */
  89 function civicrm_api3_relationship_type_delete($params) {
  90   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  91 }
  92
  93 /**
  94  * Get list defaults for relationship types.
  95  *
  96  * @see _civicrm_api3_generic_getlist_defaults
  97  *
  98  * @param array $request
  99  *
 100  * @return array
 101  */
 102 function _civicrm_api3_relationship_type_getlist_defaults($request) {
 103   return [
 104     'label_field' => 'label_a_b',
 105     'search_field' => 'label_a_b',
 106   ];
 107 }