Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for the CiviCRM APIv3 user framework join functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_UF | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: UFJoin.php 30171 2010-10-14 09:11:27Z mover $ |
36 | * | |
37 | */ | |
38 | ||
6a488035 TO |
39 | /** |
40 | * takes an associative array and creates a uf join in the database | |
41 | * | |
cf470720 TO |
42 | * @param array $params |
43 | * Assoc array of name/value pairs. | |
6a488035 | 44 | * |
a6c01b45 | 45 | * @return array |
72b3a70c | 46 | * CRM_Core_DAO_UFJoin Array |
6a488035 TO |
47 | */ |
48 | function civicrm_api3_uf_join_create($params) { | |
49 | ||
50 | $ufJoin = CRM_Core_BAO_UFJoin::create($params); | |
51 | _civicrm_api3_object_to_array($ufJoin, $ufJoinArray[]); | |
52 | return civicrm_api3_create_success($ufJoinArray, $params, 'uf_join', 'create'); | |
53 | } | |
11e09c59 TO |
54 | |
55 | /** | |
6a488035 | 56 | * Adjust Metadata for Create action |
1c88e578 | 57 | * |
cf470720 TO |
58 | * @param array $params |
59 | * Array or parameters determined by getfields. | |
1c88e578 | 60 | * @todo - suspect module, weight don't need to be required - need to test |
6a488035 TO |
61 | */ |
62 | function _civicrm_api3_uf_join_create_spec(&$params) { | |
63 | $params['module']['api.required'] = 1; | |
64 | $params['weight']['api.required'] = 1; | |
65 | $params['uf_group_id']['api.required'] = 1; | |
66 | } | |
67 | ||
68 | /** | |
69 | * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record | |
70 | * | |
cf470720 TO |
71 | * @param array $params |
72 | * (reference) an assoc array of name/value pairs. | |
6a488035 | 73 | * |
a6c01b45 | 74 | * @return array |
72b3a70c | 75 | * CiviCRM Result Array or null |
6a488035 | 76 | * @todo Delete function missing |
6a488035 TO |
77 | */ |
78 | function civicrm_api3_uf_join_get($params) { | |
79 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
80 | } |