4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 user framework group functions
32 * @package CiviCRM_APIv3
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
41 * get the contact_id given a uf_id or vice versa
43 * @param array $params
45 * @return array $result
47 * {@getfields UFMatch_get}
48 * @example UFMatchGet.php
49 * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3)
51 function civicrm_api3_uf_match_get($params) {
52 return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
56 * Create or update a UF Match record
58 * @param array $params
59 * Associative array of property.
60 * name/value pairs to insert in new 'survey'
61 * @example UFMatch.php Std Create example
63 * @return array api result array
64 * {@getfields uf_match_create}
67 function civicrm_api3_uf_match_create($params) {
68 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
72 * Adjust Metadata for Create action
74 * The metadata is used for setting defaults, documentation & validation
75 * @param array $params
76 * Array or parameters determined by getfields.
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;
85 * Create or update a survey
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
92 * @return array api result array
93 * {@getfields uf_match_create}
96 function civicrm_api3_uf_match_delete($params) {
97 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);