3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM profile group.
31 * @package CiviCRM_APIv3
35 * Adjust metadata for create action.
37 * @param array $params
39 function _civicrm_api3_uf_group_create_spec(&$params) {
40 $session = CRM_Core_Session
::singleton();
41 $params['title']['api.required'] = 1;
42 $params['is_active']['api.default'] = 1;
43 $params['is_update_dupe']['api.default'] = 1;
44 // Default to the logged in user.
45 $params['created_id']['api.default'] = 'user_contact_id';
46 $params['created_date']['api.default'] = 'now';
50 * Use this API to create a new group.
52 * See the CRM Data Model for uf_group property definitions
54 * @param array $params
55 * Array per getfields metadata.
60 function civicrm_api3_uf_group_create($params) {
61 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
65 * Returns array of uf groups (profiles) matching a set of one or more group properties.
67 * @param array $params
68 * Array of properties. If empty, all records will be returned.
71 * Array of matching profiles
73 function civicrm_api3_uf_group_get($params) {
75 return _civicrm_api3_basic_get('CRM_Core_BAO_UFGroup', $params);
81 * @param array $params
85 function civicrm_api3_uf_group_delete($params) {
86 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
90 * Set default getlist parameters.
92 * @see _civicrm_api3_generic_getlist_defaults
94 * @param array $request
98 function _civicrm_api3_uf_group_getlist_defaults(&$request) {
100 'description_field' => array(
111 * Format getlist output
113 * @see _civicrm_api3_generic_getlist_output
115 * @param array $result
116 * @param array $request
117 * @param string $entity
118 * @param array $fields
122 function _civicrm_api3_uf_group_getlist_output($result, $request, $entity, $fields) {
124 if (!empty($result['values'])) {
125 foreach ($result['values'] as $row) {
127 'id' => $row[$request['id_field']],
128 'label' => $row[$request['label_field']],
130 if (!empty($request['description_field'])) {
131 $data['description'] = array();
132 foreach ((array) $request['description_field'] as $field) {
133 if (!empty($row[$field])) {
134 // Special formatting for group_type field
135 if ($field == 'group_type') {
136 $groupTypes = CRM_UF_Page_Group
::extractGroupTypes($row[$field]);
137 $data['description'][] = CRM_UF_Page_Group
::formatGroupTypes($groupTypes);
140 if (!isset($fields[$field]['pseudoconstant'])) {
141 $data['description'][] = $row[$field];
144 $data['description'][] = CRM_Core_PseudoConstant
::getLabel(
145 _civicrm_api3_get_BAO($entity),
153 if (!empty($request['image_field'])) {
154 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';