Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
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. | | |
15 | | | | |
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. | | |
20 | | | | |
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 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 user framework join functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_UF | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $ | |
38 | * | |
39 | */ | |
40 | ||
6a488035 TO |
41 | /** |
42 | * takes an associative array and creates a uf join in the database | |
43 | * | |
44 | * @param array $params assoc array of name/value pairs | |
45 | * | |
46 | * @return array CRM_Core_DAO_UFJoin Array | |
47 | * @access public | |
48 | * @example UFJoinCreate.php | |
49 | * {@getfields UFJoin_create} | |
50 | * | |
51 | */ | |
52 | function civicrm_api3_uf_join_create($params) { | |
53 | ||
54 | $ufJoin = CRM_Core_BAO_UFJoin::create($params); | |
55 | _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]); | |
56 | return civicrm_api3_create_success($ufJoinArray, $params, 'uf_join', 'create'); | |
57 | } | |
11e09c59 TO |
58 | |
59 | /** | |
6a488035 TO |
60 | * Adjust Metadata for Create action |
61 | * | |
62 | * @param array $params array or parameters determined by getfields | |
63 | * @todo - suspect module, weight don't need to be required - need to test | |
64 | */ | |
65 | function _civicrm_api3_uf_join_create_spec(&$params) { | |
66 | $params['module']['api.required'] = 1; | |
67 | $params['weight']['api.required'] = 1; | |
68 | $params['uf_group_id']['api.required'] = 1; | |
69 | } | |
70 | ||
71 | /** | |
72 | * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record | |
73 | * | |
74 | * @param array $params (reference) an assoc array of name/value pairs | |
75 | * | |
76 | * @return array $result CiviCRM Result Array or null | |
77 | * @todo Delete function missing | |
78 | * @access public | |
79 | * {getfields UFJoin_get} | |
80 | */ | |
81 | function civicrm_api3_uf_join_get($params) { | |
82 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
83 | } | |
84 |