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 group functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_UF | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $ | |
38 | * | |
39 | */ | |
40 | ||
41 | /** | |
42 | * Files required for this package | |
43 | */ | |
44 | ||
45 | require_once 'CRM/Core/BAO/UFGroup.php'; | |
46 | ||
47 | function _civicrm_api3_uf_group_create_spec(&$params) { | |
48 | $session = CRM_Core_Session::singleton(); | |
49 | $params['title']['api.required'] = 1; | |
50 | $params['is_active']['api.default'] = 1; | |
51 | $params['is_update_dupe']['api.default'] = 1; | |
52 | $params['created_id']['api.default'] = 'user_contact_id';//the current user | |
53 | $params['created_date']['api.default'] = 'now'; | |
54 | } | |
55 | /** | |
56 | * Use this API to create a new group. See the CRM Data Model for uf_group property definitions | |
57 | * | |
58 | * @param $params array Associative array of property name/value pairs to insert in group. | |
59 | * | |
60 | * @return Newly create $ufGroupArray array | |
61 | * {@getfields UFGroup_create} | |
62 | * @example UFGroupCreate.php | |
63 | * @access public | |
64 | */ | |
65 | function civicrm_api3_uf_group_create($params) { | |
66 | ||
67 | $ids = array(); | |
68 | $ids['ufgroup'] = $params['id']; | |
69 | ||
70 | ||
71 | $ufGroup = CRM_Core_BAO_UFGroup::add($params, $ids); | |
72 | _civicrm_api3_object_to_array($ufGroup, $ufGroupArray[$ufGroup->id]); | |
73 | ||
74 | return civicrm_api3_create_success($ufGroupArray, $params); | |
75 | } | |
76 | ||
77 | /** | |
78 | * Returns array of uf groups (profiles) matching a set of one or more group properties | |
79 | * | |
80 | * @param array $params (reference) Array of one or more valid | |
81 | * property_name=>value pairs. If $params is set | |
82 | * as null, all surveys will be returned | |
83 | * | |
84 | * @return array Array of matching profiles | |
85 | * {@getfields UFGroup_get} | |
86 | * @example UFGroupGet.php | |
87 | * @access public | |
88 | */ | |
89 | function civicrm_api3_uf_group_get($params) { | |
90 | ||
91 | return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params); | |
92 | } | |
93 | ||
94 | /** | |
95 | * Delete uf group | |
96 | * | |
97 | * @param $groupId int Valid uf_group id that to be deleted | |
98 | * | |
99 | * @return true on successful delete or return error | |
100 | * @todo doesnt rtn success or error properly | |
101 | * @access public | |
102 | * {@getfields UFGroup_delete} | |
103 | * @example UFGroupDelete.php | |
104 | */ | |
105 | function civicrm_api3_uf_group_delete($params) { | |
106 | ||
107 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
108 | } | |
109 |