Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
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. | | |
14 | | | | |
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. | | |
19 | | | | |
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 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * File for the CiviCRM APIv3 user framework group functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_UF | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $ |
37 | * | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Files required for this package | |
42 | */ | |
6a488035 TO |
43 | function _civicrm_api3_uf_group_create_spec(&$params) { |
44 | $session = CRM_Core_Session::singleton(); | |
45 | $params['title']['api.required'] = 1; | |
46 | $params['is_active']['api.default'] = 1; | |
47 | $params['is_update_dupe']['api.default'] = 1; | |
48 | $params['created_id']['api.default'] = 'user_contact_id';//the current user | |
49 | $params['created_date']['api.default'] = 'now'; | |
50 | } | |
51 | /** | |
52 | * Use this API to create a new group. See the CRM Data Model for uf_group property definitions | |
53 | * | |
cf470720 TO |
54 | * @param $params |
55 | * Array Associative array of property name/value pairs to insert in group. | |
6a488035 | 56 | * |
a6c01b45 CW |
57 | * @return array |
58 | * API result array | |
6a488035 TO |
59 | * {@getfields UFGroup_create} |
60 | * @example UFGroupCreate.php | |
61 | * @access public | |
62 | */ | |
63 | function civicrm_api3_uf_group_create($params) { | |
6a73ef3f | 64 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
65 | } |
66 | ||
67 | /** | |
68 | * Returns array of uf groups (profiles) matching a set of one or more group properties | |
69 | * | |
cf470720 TO |
70 | * @param array $params |
71 | * (reference) Array of one or more valid. | |
6a488035 TO |
72 | * property_name=>value pairs. If $params is set |
73 | * as null, all surveys will be returned | |
74 | * | |
a6c01b45 CW |
75 | * @return array |
76 | * Array of matching profiles | |
6a488035 TO |
77 | * {@getfields UFGroup_get} |
78 | * @example UFGroupGet.php | |
79 | * @access public | |
80 | */ | |
81 | function civicrm_api3_uf_group_get($params) { | |
82 | ||
83 | return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params); | |
84 | } | |
85 | ||
86 | /** | |
87 | * Delete uf group | |
88 | * | |
c490a46a | 89 | * @param array $params |
7f6921be | 90 | * |
6a488035 TO |
91 | * |
92 | * @return true on successful delete or return error | |
6a488035 TO |
93 | * @access public |
94 | * {@getfields UFGroup_delete} | |
95 | * @example UFGroupDelete.php | |
96 | */ | |
97 | function civicrm_api3_uf_group_delete($params) { | |
6a488035 TO |
98 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
99 | } |