api/v3/UFMatch.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  * File for the CiviCRM APIv3 user framework group functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_UF
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
  36  *
  37  */
  38
  39 /**
  40  * get the contact_id given a uf_id or vice versa
  41  *
  42  * @param array $params
  43  *
  44  * @return array
  45  * @access public
  46  * {@getfields UFMatch_get}
  47  * @example UFMatchGet.php
  48  * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3)
  49  */
  50 function civicrm_api3_uf_match_get($params) {
  51   return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
  52 }
  53
  54 /**
  55  * Create or update a UF Match record
  56  *
  57  * @param array $params
  58  *   Associative array of property.
  59  *                       name/value pairs to insert in new 'survey'
  60  * @example UFMatch.php Std Create example
  61  *
  62  * @return array
  63  *   api result array
  64  * {@getfields uf_match_create}
  65  * @access public
  66  */
  67 function civicrm_api3_uf_match_create($params) {
  68   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  69 }
  70
  71 /**
  72  * Adjust Metadata for Create action
  73  *
  74  * The metadata is used for setting defaults, documentation & validation
  75  * @param array $params
  76  *   Array or parameters determined by getfields.
  77  */
  78 function _civicrm_api3_uf_match_create_spec(&$params) {
  79   $params['contact_id']['api.required'] = 1;
  80   $params['uf_id']['api.required'] = 1;
  81   $params['uf_name']['api.required'] = 1;
  82 }
  83
  84 /**
  85  * Create or update a survey
  86  *
  87  * @param array $params
  88  *   Associative array of property.
  89  *                       name/value pairs to insert in new 'survey'
  90  * @example UFMatch.php Std Create example
  91  *
  92  * @return array
  93  *   api result array
  94  * {@getfields uf_match_create}
  95  * @access public
  96  */
  97 function civicrm_api3_uf_match_delete($params) {
  98   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  99 }