Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
232624b1 | 5 | | CiviCRM version 4.4 | |
6a488035 TO |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | * | |
35 | * @copyright CiviCRM LLC (c) 2004-2013 | |
36 | * @version $Id: UFField.php 30171 2010-10-14 09:11:27Z mover $ | |
37 | * | |
38 | */ | |
39 | ||
6a488035 TO |
40 | /** |
41 | * Defines 'uf field' within a group. | |
42 | * | |
6a488035 TO |
43 | * @param $params array Associative array of property name/value pairs to create new uf field. |
44 | * | |
7e42d294 | 45 | * @throws API_Exception |
46 | * @internal param int $groupId Valid uf_group id | |
47 | * | |
6a488035 TO |
48 | * @return Newly created $ufFieldArray array |
49 | * | |
50 | * @access public | |
51 | * {@getfields UFField_create} | |
52 | * @example UFFieldCreate.php | |
53 | */ | |
54 | function civicrm_api3_uf_field_create($params) { | |
55 | civicrm_api3_verify_one_mandatory($params, NULL, array('field_name', 'uf_group_id')); | |
56 | $groupId = CRM_Utils_Array::value('uf_group_id', $params); | |
57 | if ((int) $groupId < 1) { | |
3f1a97cd | 58 | throw new API_Exception('Params must be a field_name-carrying array and a positive integer.'); |
6a488035 TO |
59 | } |
60 | ||
61 | $field_type = CRM_Utils_Array::value('field_type', $params); | |
62 | $field_name = CRM_Utils_Array::value('field_name', $params); | |
63 | $location_type_id = CRM_Utils_Array::value('location_type_id', $params); | |
64 | $phone_type = CRM_Utils_Array::value('phone_type_id', $params, CRM_Utils_Array::value('phone_type', $params)); | |
65 | ||
66 | if (! CRM_Core_BAO_UFField::isValidFieldName($field_name)) { | |
3f1a97cd | 67 | throw new API_Exception('The field_name is not valid'); |
6a488035 TO |
68 | } |
69 | $params['field_name'] = array($field_type, $field_name, $location_type_id, $phone_type); | |
70 | ||
71 | if (!(CRM_Utils_Array::value('group_id', $params))) { | |
72 | $params['group_id'] = $groupId; | |
73 | } | |
74 | ||
7e42d294 | 75 | $ids = $ufFieldArray = array(); |
6a488035 TO |
76 | $ids['uf_group'] = $groupId; |
77 | ||
78 | $fieldId = CRM_Utils_Array::value('id', $params); | |
79 | if (!empty($fieldId)) { | |
80 | $UFField = new CRM_core_BAO_UFField(); | |
81 | $UFField->id = $fieldId; | |
82 | if ($UFField->find(TRUE)) { | |
83 | $ids['uf_group'] = $UFField->uf_group_id; | |
84 | if (!(CRM_Utils_Array::value('group_id', $params))) { | |
85 | // this copied here from previous api function - not sure if required | |
86 | $params['group_id'] = $UFField->uf_group_id; | |
87 | } | |
88 | } | |
89 | else { | |
3f1a97cd | 90 | throw new API_Exception("there is no field for this fieldId"); |
6a488035 TO |
91 | } |
92 | $ids['uf_field'] = $fieldId; | |
93 | } | |
94 | ||
95 | if (CRM_Core_BAO_UFField::duplicateField($params, $ids)) { | |
3f1a97cd | 96 | throw new API_Exception("The field was not added. It already exists in this profile."); |
6a488035 | 97 | } |
7e42d294 | 98 | //@todo why is this even optional? Surely weight should just be 'managed' ?? |
6a488035 TO |
99 | if (CRM_Utils_Array::value('option.autoweight', $params, TRUE)) { |
100 | $params['weight'] = CRM_Core_BAO_UFField::autoWeight($params); | |
101 | } | |
102 | $ufField = CRM_Core_BAO_UFField::add($params, $ids); | |
103 | ||
104 | $fieldsType = CRM_Core_BAO_UFGroup::calculateGroupType($groupId, TRUE); | |
105 | CRM_Core_BAO_UFGroup::updateGroupTypes($groupId, $fieldsType); | |
106 | ||
107 | _civicrm_api3_object_to_array($ufField, $ufFieldArray[$ufField->id]); | |
7e42d294 | 108 | civicrm_api3('profile', 'getfields', array('cache_clear' => TRUE)); |
6a488035 TO |
109 | return civicrm_api3_create_success($ufFieldArray, $params); |
110 | } | |
111 | ||
112 | /** | |
113 | * Gets field for civicrm_uf_field create | |
114 | * | |
7e42d294 | 115 | * @param $params |
116 | * | |
6a488035 TO |
117 | * @return array fields valid for other functions |
118 | */ | |
119 | function _civicrm_api3_uf_field_create_spec(&$params) { | |
120 | $params['option.autoweight'] = array( | |
121 | 'title' => "Automatically adjust weights in UFGroup to align with UFField", | |
7e42d294 | 122 | 'type' => CRM_Utils_Type::T_BOOLEAN, |
123 | 'api.default' => TRUE, | |
6a488035 | 124 | ); |
7e42d294 | 125 | $params['created_id']['api.default'] = 'user_contact_id'; |
6a488035 TO |
126 | } |
127 | ||
128 | /** | |
129 | * Returns array of uf groups (profiles) matching a set of one or more group properties | |
130 | * | |
131 | * @param array $params (reference) Array of one or more valid | |
132 | * property_name=>value pairs. If $params is set | |
133 | * as null, all surveys will be returned | |
134 | * | |
135 | * @return array (reference) Array | |
136 | * {@getfields UFField_get | |
137 | * @example UFFieldGet.php | |
138 | * @access public | |
139 | */ | |
140 | function civicrm_api3_uf_field_get($params) { | |
141 | return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params); | |
142 | } | |
143 | ||
144 | /** | |
145 | * Delete uf field | |
146 | * | |
7e42d294 | 147 | * @param $params |
148 | * | |
149 | * @throws API_Exception | |
150 | * @internal param int $fieldId Valid uf_field id that to be deleted | |
6a488035 TO |
151 | * |
152 | * @return true on successful delete or return error | |
153 | * | |
154 | * @access public | |
155 | * {@getfields UFField_delete} | |
156 | * @example UFFieldDelete.php | |
157 | */ | |
158 | function civicrm_api3_uf_field_delete($params) { | |
159 | $fieldId = $params['id']; | |
160 | ||
161 | $ufGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFField', $fieldId, 'uf_group_id'); | |
162 | if (!$ufGroupId) { | |
3f1a97cd | 163 | throw new API_Exception('Invalid value for field_id.'); |
6a488035 TO |
164 | } |
165 | ||
166 | $result = CRM_Core_BAO_UFField::del($fieldId); | |
167 | ||
168 | $fieldsType = CRM_Core_BAO_UFGroup::calculateGroupType($ufGroupId, TRUE); | |
169 | CRM_Core_BAO_UFGroup::updateGroupTypes($ufGroupId, $fieldsType); | |
170 | ||
171 | return civicrm_api3_create_success($result, $params); | |
172 | } | |
7e42d294 | 173 | /** |
174 | * field id accepted for backward compatibility - unset required on id | |
6a488035 TO |
175 | */ |
176 | function _civicrm_api3_uf_field_delete_spec(&$params) { | |
177 | // legacy support for field_id | |
178 | $params['id']['api.aliases'] = array('field_id'); | |
179 | } | |
180 |