api/v3/UFMatch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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 user framework match.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Get the contact_id given a uf_id or vice versa.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  */
  41 function civicrm_api3_uf_match_get($params) {
  42   return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
  43 }
  44
  45 /**
  46  * Create or update a UF Match record.
  47  *
  48  * @param array $params
  49  *   Array per getfields metadata.
  50  *
  51  * @return array
  52  *   Api result array
  53  */
  54 function civicrm_api3_uf_match_create($params) {
  55   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'UFMatch');
  56 }
  57
  58 /**
  59  * Adjust Metadata for Create action.
  60  *
  61  * The metadata is used for setting defaults, documentation & validation.
  62  *
  63  * @param array $params
  64  *   Array of parameters determined by getfields.
  65  */
  66 function _civicrm_api3_uf_match_create_spec(&$params) {
  67   $params['contact_id']['api.required'] = 1;
  68   $params['uf_id']['api.required'] = 1;
  69   $params['uf_name']['api.required'] = 1;
  70 }
  71
  72 /**
  73  * Delete a UF Match record.
  74  *
  75  * @param array $params
  76  *
  77  * @return array
  78  *   Api result array.
  79  */
  80 function civicrm_api3_uf_match_delete($params) {
  81   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }