5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 user framework group functions
33 * @package CiviCRM_APIv3
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
42 * Files required for this package
45 require_once 'CRM/Core/BAO/UFGroup.php';
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';
56 * Use this API to create a new group. See the CRM Data Model for uf_group property definitions
58 * @param $params array Associative array of property name/value pairs to insert in group.
60 * @return Newly create $ufGroupArray array
61 * {@getfields UFGroup_create}
62 * @example UFGroupCreate.php
65 function civicrm_api3_uf_group_create($params) {
68 $ids['ufgroup'] = $params['id'];
71 $ufGroup = CRM_Core_BAO_UFGroup
::add($params, $ids);
72 _civicrm_api3_object_to_array($ufGroup, $ufGroupArray[$ufGroup->id
]);
74 return civicrm_api3_create_success($ufGroupArray, $params);
78 * Returns array of uf groups (profiles) matching a set of one or more group properties
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
84 * @return array Array of matching profiles
85 * {@getfields UFGroup_get}
86 * @example UFGroupGet.php
89 function civicrm_api3_uf_group_get($params) {
91 return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
97 * @param $groupId int Valid uf_group id that to be deleted
99 * @return true on successful delete or return error
100 * @todo doesnt rtn success or error properly
102 * {@getfields UFGroup_delete}
103 * @example UFGroupDelete.php
105 function civicrm_api3_uf_group_delete($params) {
107 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);