api/v3/UFMatch.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 user framework group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_UF
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
  37  *
  38  */
  39
  40 /**
  41  * get the contact_id given a uf_id or vice versa
  42  *
  43  * @param array $params
  44  *
  45  * @return array $result
  46  * @access public
  47  * {@getfields UFMatch_get}
  48  * @example UFMatchGet.php
  49  * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3)
  50  */
  51 function civicrm_api3_uf_match_get($params) {
  52   return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
  53 }
  54
  55 /**
  56  * Create or update a UF Match record
  57  *
  58  * @param array $params  Associative array of property
  59  *                       name/value pairs to insert in new 'survey'
  60  * @example UFMatch.php Std Create example
  61  *
  62  * @return array api result array
  63  * {@getfields uf_match_create}
  64  * @access public
  65  */
  66 function civicrm_api3_uf_match_create($params) {
  67   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  68 }
  69
  70 /**
  71  * Adjust Metadata for Create action
  72  *
  73  * The metadata is used for setting defaults, documentation & validation
  74  * @param array $params array or parameters determined by getfields
  75  */
  76 function _civicrm_api3_uf_match_create_spec(&$params) {
  77   $params['contact_id']['api.required'] = 1;
  78   $params['uf_id']['api.required'] = 1;
  79   $params['uf_name']['api.required'] = 1;
  80   // note that this should perhaps not be required but need a wrapper level approach
  81   // prefera
  82   $params['domain_id']['api.required'] = 1;
  83 }
  84
  85 /**
  86  * Create or update a survey
  87  *
  88  * @param array $params  Associative array of property
  89  *                       name/value pairs to insert in new 'survey'
  90  * @example UFMatch.php Std Create example
  91  *
  92  * @return array api result array
  93  * {@getfields uf_match_create}
  94  * @access public
  95  */
  96 function civicrm_api3_uf_match_delete($params) {
  97   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }
  99