api/v3/UFField.php

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