3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 user framework group functions
31 * @package CiviCRM_APIv3
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: UFField.php 30171 2010-10-14 09:11:27Z mover $
40 * Defines 'uf field' within a group.
42 * @param array $params
43 * Array Associative array of property name/value pairs to create new uf field.
45 * @throws API_Exception
48 * Newly created $ufFieldArray
50 function civicrm_api3_uf_field_create($params) {
51 civicrm_api3_verify_one_mandatory($params, NULL, array('field_name', 'uf_group_id'));
52 $groupId = CRM_Utils_Array
::value('uf_group_id', $params);
53 if ((int) $groupId < 1) {
54 throw new API_Exception('Params must be a field_name-carrying array and a positive integer.');
57 $field_type = CRM_Utils_Array
::value('field_type', $params);
58 $field_name = CRM_Utils_Array
::value('field_name', $params);
59 $location_type_id = CRM_Utils_Array
::value('location_type_id', $params);
60 $phone_type = CRM_Utils_Array
::value('phone_type_id', $params, CRM_Utils_Array
::value('phone_type', $params));
62 if (! CRM_Core_BAO_UFField
::isValidFieldName($field_name)) {
63 throw new API_Exception('The field_name is not valid');
65 $params['field_name'] = array($field_type, $field_name, $location_type_id, $phone_type);
67 if (!(CRM_Utils_Array
::value('group_id', $params))) {
68 $params['group_id'] = $groupId;
71 $ids = $ufFieldArray = array();
72 $ids['uf_group'] = $groupId;
74 $fieldId = CRM_Utils_Array
::value('id', $params);
75 if (!empty($fieldId)) {
76 $UFField = new CRM_Core_BAO_UFField();
77 $UFField->id
= $fieldId;
78 if ($UFField->find(TRUE)) {
79 $ids['uf_group'] = $UFField->uf_group_id
;
80 if (!(CRM_Utils_Array
::value('group_id', $params))) {
81 // this copied here from previous api function - not sure if required
82 $params['group_id'] = $UFField->uf_group_id
;
86 throw new API_Exception("there is no field for this fieldId");
88 $ids['uf_field'] = $fieldId;
91 if (CRM_Core_BAO_UFField
::duplicateField($params, $ids)) {
92 throw new API_Exception("The field was not added. It already exists in this profile.");
94 //@todo why is this even optional? Surely weight should just be 'managed' ??
95 if (CRM_Utils_Array
::value('option.autoweight', $params, TRUE)) {
96 $params['weight'] = CRM_Core_BAO_UFField
::autoWeight($params);
98 $ufField = CRM_Core_BAO_UFField
::add($params, $ids);
100 $fieldsType = CRM_Core_BAO_UFGroup
::calculateGroupType($groupId, TRUE);
101 CRM_Core_BAO_UFGroup
::updateGroupTypes($groupId, $fieldsType);
103 _civicrm_api3_object_to_array($ufField, $ufFieldArray[$ufField->id
]);
104 civicrm_api3('profile', 'getfields', array('cache_clear' => TRUE));
105 return civicrm_api3_create_success($ufFieldArray, $params);
109 * Gets field for civicrm_uf_field create
111 * @param array $params
114 * fields valid for other functions
116 function _civicrm_api3_uf_field_create_spec(&$params) {
117 $params['option.autoweight'] = array(
118 'title' => "Automatically adjust weights in UFGroup to align with UFField",
119 'type' => CRM_Utils_Type
::T_BOOLEAN
,
120 'api.default' => TRUE,
122 $params['created_id']['api.default'] = 'user_contact_id';
123 $params['created_id']['title'] = 'Created By';
124 $params['is_active']['api.default'] = TRUE;
128 * Returns array of uf groups (profiles) matching a set of one or more group properties
130 * @param array $params
131 * (reference) Array of one or more valid.
132 * property_name=>value pairs. If $params is set
133 * as null, all surveys will be returned
137 * {@getfields UFField_get
138 * @example UFFieldGet.php
140 function civicrm_api3_uf_field_get($params) {
141 return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
147 * @param array $params
149 * @throws API_Exception
153 function civicrm_api3_uf_field_delete($params) {
154 $fieldId = $params['id'];
156 $ufGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFField', $fieldId, 'uf_group_id');
158 throw new API_Exception('Invalid value for field_id.');
161 $result = CRM_Core_BAO_UFField
::del($fieldId);
163 $fieldsType = CRM_Core_BAO_UFGroup
::calculateGroupType($ufGroupId, TRUE);
164 CRM_Core_BAO_UFGroup
::updateGroupTypes($ufGroupId, $fieldsType);
166 return civicrm_api3_create_success($result, $params);
170 * field id accepted for backward compatibility - unset required on id
171 * @param array $params
173 function _civicrm_api3_uf_field_delete_spec(&$params) {
174 // legacy support for field_id
175 $params['id']['api.aliases'] = array('field_id');