api/v3/UFField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM profile field.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Defines 'uf field' within a group.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @throws API_Exception
  41  *
  42  * @return array
  43  *   Newly created $ufFieldArray
  44  */
  45 function civicrm_api3_uf_field_create($params) {
  46   // CRM-14756: kind of a hack-ish fix. If the user gives the id, uf_group_id is retrieved and then set.
  47   if (isset($params['id'])) {
  48     $groupId = civicrm_api3('UFField', 'getvalue', array(
  49       'return' => 'uf_group_id',
  50       'id' => $params['id'],
  51     ));
  52   }
  53   else {
  54     $groupId = CRM_Utils_Array::value('uf_group_id', $params);
  55   }
  56
  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, CRM_Utils_Array::value('website_type_id', $params));
  60   $phone_type       = CRM_Utils_Array::value('phone_type_id', $params, CRM_Utils_Array::value('phone_type', $params));
  61
  62   if (strpos($field_name, 'formatting') !== 0 && !CRM_Core_BAO_UFField::isValidFieldName($field_name)) {
  63     throw new API_Exception('The field_name is not valid');
  64   }
  65   $params['field_name'] = array($field_type, $field_name, $location_type_id, $phone_type);
  66
  67   if (!(CRM_Utils_Array::value('group_id', $params))) {
  68     $params['group_id'] = $groupId;
  69   }
  70
  71   $ids = $ufFieldArray = array();
  72   $ids['uf_group'] = $groupId;
  73
  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;
  83       }
  84     }
  85     else {
  86       throw new API_Exception("there is no field for this fieldId");
  87     }
  88     $ids['uf_field'] = $fieldId;
  89   }
  90
  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.");
  93   }
  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);
  97   }
  98   $ufField = CRM_Core_BAO_UFField::add($params);
  99
 100   $fieldsType = CRM_Core_BAO_UFGroup::calculateGroupType($groupId, TRUE);
 101   CRM_Core_BAO_UFGroup::updateGroupTypes($groupId, $fieldsType);
 102
 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);
 106 }
 107
 108 /**
 109  * Adjust metadata for civicrm_uf_field create.
 110  *
 111  * @param array $params
 112  */
 113 function _civicrm_api3_uf_field_create_spec(&$params) {
 114   $params['field_name']['api.required'] = TRUE;
 115   $params['uf_group_id']['api.required'] = TRUE;
 116
 117   $params['option.autoweight'] = array(
 118     'title' => "Auto Weight",
 119     'description' => "Automatically adjust weights in UFGroup to align with UFField",
 120     'type' => CRM_Utils_Type::T_BOOLEAN,
 121     'api.default' => TRUE,
 122   );
 123   $params['is_active']['api.default'] = TRUE;
 124 }
 125
 126 /**
 127  * Returns array of uf groups (profiles) matching a set of one or more group properties.
 128  *
 129  * @param array $params
 130  *   Array per getfields metadata.
 131  *
 132  * @return array
 133  */
 134 function civicrm_api3_uf_field_get($params) {
 135   return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
 136 }
 137
 138 /**
 139  * Delete uf field.
 140  *
 141  * @param array $params
 142  *
 143  * @throws API_Exception
 144  *
 145  * @return array
 146  */
 147 function civicrm_api3_uf_field_delete($params) {
 148   $fieldId = $params['id'];
 149
 150   $ufGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFField', $fieldId, 'uf_group_id');
 151   if (!$ufGroupId) {
 152     throw new API_Exception('Invalid value for field_id.');
 153   }
 154
 155   $result = CRM_Core_BAO_UFField::del($fieldId);
 156
 157   $fieldsType = CRM_Core_BAO_UFGroup::calculateGroupType($ufGroupId, TRUE);
 158   CRM_Core_BAO_UFGroup::updateGroupTypes($ufGroupId, $fieldsType);
 159
 160   return civicrm_api3_create_success($result, $params);
 161 }
 162
 163 /**
 164  * Field id accepted for backward compatibility - unset required on id.
 165  *
 166  * @param array $params
 167  */
 168 function _civicrm_api3_uf_field_delete_spec(&$params) {
 169   // legacy support for field_id
 170   $params['id']['api.aliases'] = array('field_id');
 171 }