030bd99c1362c1ecd0e3289ad4133eab19b38cab
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: UFField.php 30171 2010-10-14 09:11:27Z mover $
42 * Defines 'uf field' within a group.
44 * @param $groupId int Valid uf_group id
46 * @param $params array Associative array of property name/value pairs to create new uf field.
48 * @return Newly created $ufFieldArray array
51 * {@getfields UFField_create}
52 * @example UFFieldCreate.php
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) {
58 return civicrm_api3_create_error('Params must be a field_name-carrying array and a positive integer.');
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));
66 if (! CRM_Core_BAO_UFField
::isValidFieldName($field_name)) {
67 return civicrm_api3_create_error('The field_name is not valid');
69 $params['field_name'] = array($field_type, $field_name, $location_type_id, $phone_type);
71 if (!(CRM_Utils_Array
::value('group_id', $params))) {
72 $params['group_id'] = $groupId;
76 $ids['uf_group'] = $groupId;
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
;
90 return civicrm_api3_create_error("there is no field for this fieldId");
92 $ids['uf_field'] = $fieldId;
95 if (CRM_Core_BAO_UFField
::duplicateField($params, $ids)) {
96 return civicrm_api3_create_error("The field was not added. It already exists in this profile.");
98 if (CRM_Utils_Array
::value('option.autoweight', $params, TRUE)) {
99 $params['weight'] = CRM_Core_BAO_UFField
::autoWeight($params);
101 $ufField = CRM_Core_BAO_UFField
::add($params, $ids);
103 $fieldsType = CRM_Core_BAO_UFGroup
::calculateGroupType($groupId, TRUE);
104 CRM_Core_BAO_UFGroup
::updateGroupTypes($groupId, $fieldsType);
106 _civicrm_api3_object_to_array($ufField, $ufFieldArray[$ufField->id
]);
107 return civicrm_api3_create_success($ufFieldArray, $params);
111 * Gets field for civicrm_uf_field create
113 * @return array fields valid for other functions
115 function _civicrm_api3_uf_field_create_spec(&$params) {
116 $params['option.autoweight'] = array(
117 'title' => "Automatically adjust weights in UFGroup to align with UFField",
118 'type' => CRM_Utils_Type
::T_BOOL
123 * Returns array of uf groups (profiles) matching a set of one or more group properties
125 * @param array $params (reference) Array of one or more valid
126 * property_name=>value pairs. If $params is set
127 * as null, all surveys will be returned
129 * @return array (reference) Array
130 * {@getfields UFField_get
131 * @example UFFieldGet.php
134 function civicrm_api3_uf_field_get($params) {
135 return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
141 * @param $fieldId int Valid uf_field id that to be deleted
143 * @return true on successful delete or return error
146 * {@getfields UFField_delete}
147 * @example UFFieldDelete.php
149 function civicrm_api3_uf_field_delete($params) {
150 $fieldId = $params['id'];
152 $ufGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFField', $fieldId, 'uf_group_id');
154 return civicrm_api3_create_error('Invalid value for field_id.');
157 $result = CRM_Core_BAO_UFField
::del($fieldId);
159 $fieldsType = CRM_Core_BAO_UFGroup
::calculateGroupType($ufGroupId, TRUE);
160 CRM_Core_BAO_UFGroup
::updateGroupTypes($ufGroupId, $fieldsType);
162 return civicrm_api3_create_success($result, $params);
165 * field id accepted for backward compat - unset required on id
167 function _civicrm_api3_uf_field_delete_spec(&$params) {
168 // legacy support for field_id
169 $params['id']['api.aliases'] = array('field_id');