5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 user framework group functions
33 * @package CiviCRM_APIv3
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
42 * get the contact_id given a uf_id or vice versa
44 * @param array $params
46 * @return array $result
48 * {@getfields UFMatch_get}
49 * @example UFMatchGet.php
50 * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3)
52 function civicrm_api3_uf_match_get($params) {
53 return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
57 * Create or update a UF Match record
59 * @param array $params 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);
71 * Adjust Metadata for Create action
73 * The metadata is used for setting defaults, documentation & validation
74 * @param array $params array or parameters determined by getfields
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
82 $params['domain_id']['api.required'] = 1;
86 * Create or update a survey
88 * @param array $params 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);