4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.3 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
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 join functions
32 * @package CiviCRM_APIv3
35 * @copyright CiviCRM LLC (c) 2004-2013
36 * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $
41 * takes an associative array and creates a uf join in the database
43 * @param array $params assoc array of name/value pairs
45 * @return array CRM_Core_DAO_UFJoin Array
47 * @example UFJoinCreate.php
48 * {@getfields UFJoin_create}
51 function civicrm_api3_uf_join_create($params) {
53 $ufJoin = CRM_Core_BAO_UFJoin
::create($params);
54 _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]);
55 return civicrm_api3_create_success($ufJoinArray, $params, 'uf_join', 'create');
59 * Adjust Metadata for Create action
61 * @param array $params array or parameters determined by getfields
62 * @todo - suspect module, weight don't need to be required - need to test
64 function _civicrm_api3_uf_join_create_spec(&$params) {
65 $params['module']['api.required'] = 1;
66 $params['weight']['api.required'] = 1;
67 $params['uf_group_id']['api.required'] = 1;
71 * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record
73 * @param array $params (reference) an assoc array of name/value pairs
75 * @return array $result CiviCRM Result Array or null
76 * @todo Delete function missing
78 * {getfields UFJoin_get}
80 function civicrm_api3_uf_join_get($params) {
81 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);