CRM/Core/BAO/CustomField.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * Business objects for managing custom data fields.
  36  */
  37 class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField {
  38
  39   /**
  40    * Array for valid combinations of data_type & descriptions.
  41    *
  42    * @var array
  43    */
  44   public static $_dataType = NULL;
  45
  46   /**
  47    * Array for valid combinations of data_type & html_type.
  48    *
  49    * @var array
  50    */
  51   public static $_dataToHtml = NULL;
  52
  53   /**
  54    * Array to hold (formatted) fields for import
  55    *
  56    * @var array
  57    */
  58   public static $_importFields = NULL;
  59
  60   /**
  61    * Build and retrieve the list of data types and descriptions.
  62    *
  63    * @return array
  64    *   Data type => Description
  65    */
  66   public static function &dataType() {
  67     if (!(self::$_dataType)) {
  68       self::$_dataType = array(
  69         'String' => ts('Alphanumeric'),
  70         'Int' => ts('Integer'),
  71         'Float' => ts('Number'),
  72         'Money' => ts('Money'),
  73         'Memo' => ts('Note'),
  74         'Date' => ts('Date'),
  75         'Boolean' => ts('Yes or No'),
  76         'StateProvince' => ts('State/Province'),
  77         'Country' => ts('Country'),
  78         'File' => ts('File'),
  79         'Link' => ts('Link'),
  80         'ContactReference' => ts('Contact Reference'),
  81       );
  82     }
  83     return self::$_dataType;
  84   }
  85
  86   /**
  87    * Build the map of custom field's data types and there respective Util type
  88    *
  89    * @return array
  90    *   Data data-type => CRM_Utils_Type
  91    */
  92   public static function dataToType() {
  93     return [
  94       'String' => CRM_Utils_Type::T_STRING,
  95       'Int' => CRM_Utils_Type::T_INT,
  96       'Money' => CRM_Utils_Type::T_MONEY,
  97       'Memo' => CRM_Utils_Type::T_LONGTEXT,
  98       'Float' => CRM_Utils_Type::T_FLOAT,
  99       'Date' => CRM_Utils_Type::T_DATE,
 100       'DateTime' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 101       'Boolean' => CRM_Utils_Type::T_BOOLEAN,
 102       'StateProvince' => CRM_Utils_Type::T_INT,
 103       'File' => CRM_Utils_Type::T_STRING,
 104       'Link' => CRM_Utils_Type::T_STRING,
 105       'ContactReference' => CRM_Utils_Type::T_INT,
 106       'Country' => CRM_Utils_Type::T_INT,
 107     ];
 108   }
 109
 110   /**
 111    * Get data to html array.
 112    *
 113    * (Does this caching achieve anything?)
 114    *
 115    * @return array
 116    */
 117   public static function dataToHtml() {
 118     if (!self::$_dataToHtml) {
 119       self::$_dataToHtml = array(
 120         array(
 121           'Text' => 'Text',
 122           'Select' => 'Select',
 123           'Radio' => 'Radio',
 124           'CheckBox' => 'CheckBox',
 125           'Multi-Select' => 'Multi-Select',
 126           'Autocomplete-Select' => 'Autocomplete-Select',
 127         ),
 128         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 129         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 130         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 131         array('TextArea' => 'TextArea', 'RichTextEditor' => 'RichTextEditor'),
 132         array('Date' => 'Select Date'),
 133         array('Radio' => 'Radio'),
 134         array('StateProvince' => 'Select State/Province', 'Multi-Select' => 'Multi-Select State/Province'),
 135         array('Country' => 'Select Country', 'Multi-Select' => 'Multi-Select Country'),
 136         array('File' => 'File'),
 137         array('Link' => 'Link'),
 138         array('ContactReference' => 'Autocomplete-Select'),
 139       );
 140     }
 141     return self::$_dataToHtml;
 142   }
 143
 144   /**
 145    * Takes an associative array and creates a custom field object.
 146    *
 147    * This function is invoked from within the web form layer and also from the api layer
 148    *
 149    * @param array $params
 150    *   (reference) an assoc array of name/value pairs.
 151    *
 152    * @return CRM_Core_DAO_CustomField
 153    */
 154   public static function create(&$params) {
 155     $origParams = array_merge(array(), $params);
 156
 157     $op = empty($params['id']) ? 'create' : 'edit';
 158
 159     CRM_Utils_Hook::pre($op, 'CustomField', CRM_Utils_Array::value('id', $params), $params);
 160
 161     if ($op == 'create') {
 162       if (!isset($params['column_name'])) {
 163         // if add mode & column_name not present, calculate it.
 164         $params['column_name'] = strtolower(CRM_Utils_String::munge($params['label'], '_', 32));
 165       }
 166       if (!isset($params['name'])) {
 167         $params['name'] = CRM_Utils_String::munge($params['label'], '_', 64);
 168       }
 169     }
 170     else {
 171       $params['column_name'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 172         $params['id'],
 173         'column_name'
 174       );
 175     }
 176     $columnName = $params['column_name'];
 177
 178     $indexExist = FALSE;
 179     //as during create if field is_searchable we had created index.
 180     if (!empty($params['id'])) {
 181       $indexExist = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'is_searchable');
 182     }
 183
 184     switch (CRM_Utils_Array::value('html_type', $params)) {
 185       case 'Select Date':
 186         if (empty($params['date_format'])) {
 187           $config = CRM_Core_Config::singleton();
 188           $params['date_format'] = $config->dateInputFormat;
 189         }
 190         break;
 191
 192       case 'CheckBox':
 193       case 'Multi-Select':
 194         if (isset($params['default_checkbox_option'])) {
 195           $tempArray = array_keys($params['default_checkbox_option']);
 196           $defaultArray = array();
 197           foreach ($tempArray as $k => $v) {
 198             if ($params['option_value'][$v]) {
 199               $defaultArray[] = $params['option_value'][$v];
 200             }
 201           }
 202
 203           if (!empty($defaultArray)) {
 204             // also add the separator before and after the value per new convention (CRM-1604)
 205             $params['default_value'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $defaultArray) . CRM_Core_DAO::VALUE_SEPARATOR;
 206           }
 207         }
 208         else {
 209           if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])
 210           ) {
 211             $params['default_value'] = $params['option_value'][$params['default_option']];
 212           }
 213         }
 214         break;
 215     }
 216
 217     $transaction = new CRM_Core_Transaction();
 218
 219     $htmlType = CRM_Utils_Array::value('html_type', $params);
 220     $dataType = CRM_Utils_Array::value('data_type', $params);
 221     $allowedOptionTypes = array('String', 'Int', 'Float', 'Money');
 222
 223     // create any option group & values if required
 224     if ($htmlType != 'Text' && in_array($dataType, $allowedOptionTypes)
 225     ) {
 226       //CRM-16659: if option_value then create an option group for this custom field.
 227       if ($params['option_type'] == 1 && (empty($params['option_group_id']) || !empty($params['option_value']))) {
 228         // first create an option group for this custom group
 229         $optionGroup = new CRM_Core_DAO_OptionGroup();
 230         $optionGroup->name = "{$columnName}_" . date('YmdHis');
 231         $optionGroup->title = $params['label'];
 232         $optionGroup->is_active = 1;
 233         // Don't set reserved as it's not a built-in option group and may be useful for other custom fields.
 234         $optionGroup->is_reserved = 0;
 235         $optionGroup->data_type = $dataType;
 236         $optionGroup->save();
 237         $params['option_group_id'] = $optionGroup->id;
 238         if (!empty($params['option_value']) && is_array($params['option_value'])) {
 239           foreach ($params['option_value'] as $k => $v) {
 240             if (strlen(trim($v))) {
 241               $optionValue = new CRM_Core_DAO_OptionValue();
 242               $optionValue->option_group_id = $optionGroup->id;
 243               $optionValue->label = $params['option_label'][$k];
 244               $optionValue->name = CRM_Utils_String::titleToVar($params['option_label'][$k]);
 245               switch ($dataType) {
 246                 case 'Money':
 247                   $optionValue->value = CRM_Utils_Rule::cleanMoney($v);
 248                   break;
 249
 250                 case 'Int':
 251                   $optionValue->value = intval($v);
 252                   break;
 253
 254                 case 'Float':
 255                   $optionValue->value = floatval($v);
 256                   break;
 257
 258                 default:
 259                   $optionValue->value = trim($v);
 260               }
 261
 262               $optionValue->weight = $params['option_weight'][$k];
 263               $optionValue->is_active = CRM_Utils_Array::value($k, $params['option_status'], FALSE);
 264               $optionValue->save();
 265             }
 266           }
 267         }
 268       }
 269     }
 270
 271     // check for orphan option groups
 272     if (!empty($params['option_group_id'])) {
 273       if (!empty($params['id'])) {
 274         self::fixOptionGroups($params['id'], $params['option_group_id']);
 275       }
 276
 277       // if we do not have a default value
 278       // retrieve it from one of the other custom fields which use this option group
 279       if (empty($params['default_value'])) {
 280         //don't insert only value separator as default value, CRM-4579
 281         $defaultValue = self::getOptionGroupDefault($params['option_group_id'],
 282           $htmlType
 283         );
 284
 285         if (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR,
 286           $defaultValue
 287         ))
 288         ) {
 289           $params['default_value'] = $defaultValue;
 290         }
 291       }
 292     }
 293
 294     // since we need to save option group id :)
 295     if (!isset($params['attributes']) && strtolower($htmlType) == 'textarea') {
 296       $params['attributes'] = 'rows=4, cols=60';
 297     }
 298
 299     $customField = new CRM_Core_DAO_CustomField();
 300     $customField->copyValues($params);
 301     if ($op == 'create') {
 302       $customField->is_required = CRM_Utils_Array::value('is_required', $params, FALSE);
 303       $customField->is_searchable = CRM_Utils_Array::value('is_searchable', $params, FALSE);
 304       $customField->in_selector = CRM_Utils_Array::value('in_selector', $params, FALSE);
 305       $customField->is_search_range = CRM_Utils_Array::value('is_search_range', $params, FALSE);
 306       //CRM-15792 - Custom field gets disabled if is_active not set
 307       $customField->is_active = CRM_Utils_Array::value('is_active', $params, TRUE);
 308       $customField->is_view = CRM_Utils_Array::value('is_view', $params, FALSE);
 309     }
 310     $customField->save();
 311
 312     // make sure all values are present in the object for further processing
 313     $customField->find(TRUE);
 314
 315     $triggerRebuild = CRM_Utils_Array::value('triggerRebuild', $params, TRUE);
 316     //create/drop the index when we toggle the is_searchable flag
 317     if ($op == 'edit') {
 318       self::createField($customField, 'modify', $indexExist, $triggerRebuild);
 319     }
 320     else {
 321       if (!isset($origParams['column_name'])) {
 322         $columnName .= "_{$customField->id}";
 323         $params['column_name'] = $columnName;
 324       }
 325       $customField->column_name = $columnName;
 326       $customField->save();
 327       // make sure all values are present in the object
 328       $customField->find(TRUE);
 329
 330       $indexExist = FALSE;
 331       self::createField($customField, 'add', $indexExist, $triggerRebuild);
 332     }
 333
 334     // complete transaction
 335     $transaction->commit();
 336
 337     CRM_Utils_Hook::post($op, 'CustomField', $customField->id, $customField);
 338
 339     CRM_Utils_System::flushCache();
 340
 341     return $customField;
 342   }
 343
 344   /**
 345    * Fetch object based on array of properties.
 346    *
 347    * @param array $params
 348    *   (reference ) an assoc array of name/value pairs.
 349    * @param array $defaults
 350    *   (reference ) an assoc array to hold the flattened values.
 351    *
 352    * @return CRM_Core_DAO_CustomField
 353    */
 354   public static function retrieve(&$params, &$defaults) {
 355     return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
 356   }
 357
 358   /**
 359    * Update the is_active flag in the db.
 360    *
 361    * @param int $id
 362    *   Id of the database record.
 363    * @param bool $is_active
 364    *   Value we want to set the is_active field.
 365    *
 366    * @return bool
 367    *   true if we found and updated the object, else false
 368    */
 369   public static function setIsActive($id, $is_active) {
 370
 371     CRM_Utils_System::flushCache();
 372
 373     //enable-disable CustomField
 374     CRM_Core_BAO_UFField::setUFField($id, $is_active);
 375     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
 376   }
 377
 378   /**
 379    * Get the field title.
 380    *
 381    * @param int $id
 382    *   Id of field.
 383    *
 384    * @return string
 385    *   name
 386    */
 387   public static function getTitle($id) {
 388     return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
 389   }
 390
 391   /**
 392    * @param string $context
 393    * @return array|bool
 394    */
 395   public function getOptions($context = NULL) {
 396     CRM_Core_DAO::buildOptionsContext($context);
 397
 398     if (!$this->id) {
 399       return FALSE;
 400     }
 401     if (!$this->data_type || !$this->custom_group_id) {
 402       $this->find(TRUE);
 403     }
 404
 405     // This will hold the list of options in format key => label
 406     $options = [];
 407
 408     if (!empty($this->option_group_id)) {
 409       $options = CRM_Core_OptionGroup::valuesByID(
 410         $this->option_group_id,
 411         FALSE,
 412         FALSE,
 413         FALSE,
 414         'label',
 415         !($context == 'validate' || $context == 'get')
 416       );
 417     }
 418     elseif ($this->data_type === 'StateProvince') {
 419       $options = CRM_Core_Pseudoconstant::stateProvince();
 420     }
 421     elseif ($this->data_type === 'Country') {
 422       $options = $context == 'validate' ? CRM_Core_Pseudoconstant::countryIsoCode() : CRM_Core_Pseudoconstant::country();
 423     }
 424     elseif ($this->data_type === 'Boolean') {
 425       $options = $context == 'validate' ? array(0, 1) : CRM_Core_SelectValues::boolean();
 426     }
 427     CRM_Utils_Hook::customFieldOptions($this->id, $options, FALSE);
 428     CRM_Utils_Hook::fieldOptions($this->getEntity(), "custom_{$this->id}", $options, array('context' => $context));
 429     return $options;
 430   }
 431
 432   /**
 433    * Store and return an array of all active custom fields.
 434    *
 435    * @param string $customDataType
 436    *   Type of Custom Data; empty is a synonym for "all contact data types".
 437    * @param bool $showAll
 438    *   If true returns all fields (includes disabled fields).
 439    * @param bool $inline
 440    *   If true returns all inline fields (includes disabled fields).
 441    * @param int $customDataSubType
 442    *   Custom Data sub type value.
 443    * @param int $customDataSubName
 444    *   Custom Data sub name value.
 445    * @param bool $onlyParent
 446    *   Return only top level custom data, for eg, only Participant and ignore subname and subtype.
 447    * @param bool $onlySubType
 448    *   Return only custom data for subtype.
 449    * @param bool $checkPermission
 450    *   If false, do not include permissioning clause.
 451    *
 452    * @return array
 453    *   an array of active custom fields.
 454    */
 455   public static function &getFields(
 456     $customDataType = 'Individual',
 457     $showAll = FALSE,
 458     $inline = FALSE,
 459     $customDataSubType = NULL,
 460     $customDataSubName = NULL,
 461     $onlyParent = FALSE,
 462     $onlySubType = FALSE,
 463     $checkPermission = TRUE
 464   ) {
 465     if (empty($customDataType)) {
 466       $customDataType = array('Contact', 'Individual', 'Organization', 'Household');
 467     }
 468     if ($customDataType && !is_array($customDataType)) {
 469
 470       if (in_array($customDataType, CRM_Contact_BAO_ContactType::subTypes())) {
 471         // This is the case when getFieldsForImport() requires fields
 472         // limited strictly to a subtype.
 473         $customDataSubType = $customDataType;
 474         $customDataType = CRM_Contact_BAO_ContactType::getBasicType($customDataType);
 475         $onlySubType = TRUE;
 476       }
 477
 478       if (in_array($customDataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
 479         // this makes the method flexible to support retrieving fields
 480         // for multiple extends value.
 481         $customDataType = array($customDataType);
 482       }
 483     }
 484
 485     $customDataSubType = CRM_Utils_Array::explodePadded($customDataSubType);
 486
 487     if (is_array($customDataType)) {
 488       $cacheKey = implode('_', $customDataType);
 489     }
 490     else {
 491       $cacheKey = $customDataType;
 492     }
 493
 494     $cacheKey .= !empty($customDataSubType) ? ('_' . implode('_', $customDataSubType)) : '_0';
 495     $cacheKey .= $customDataSubName ? "{$customDataSubName}_" : '_0';
 496     $cacheKey .= $showAll ? '_1' : '_0';
 497     $cacheKey .= $inline ? '_1_' : '_0_';
 498     $cacheKey .= $onlyParent ? '_1_' : '_0_';
 499     $cacheKey .= $onlySubType ? '_1_' : '_0_';
 500     $cacheKey .= $checkPermission ? '_1_' : '_0_';
 501
 502     $cgTable = CRM_Core_DAO_CustomGroup::getTableName();
 503
 504     // also get the permission stuff here
 505     if ($checkPermission) {
 506       $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
 507         "{$cgTable}."
 508       );
 509     }
 510     else {
 511       $permissionClause = '(1)';
 512     }
 513
 514     // lets md5 permission clause and take first 8 characters
 515     $cacheKey .= substr(md5($permissionClause), 0, 8);
 516
 517     if (strlen($cacheKey) > 40) {
 518       $cacheKey = md5($cacheKey);
 519     }
 520
 521     if (!self::$_importFields ||
 522       CRM_Utils_Array::value($cacheKey, self::$_importFields) === NULL
 523     ) {
 524       if (!self::$_importFields) {
 525         self::$_importFields = array();
 526       }
 527
 528       // check if we can retrieve from database cache
 529       $fields = CRM_Core_BAO_Cache::getItem('contact fields', "custom importableFields $cacheKey");
 530
 531       if ($fields === NULL) {
 532         $cfTable = self::getTableName();
 533
 534         $extends = '';
 535         if (is_array($customDataType)) {
 536           $value = NULL;
 537           foreach ($customDataType as $dataType) {
 538             if (in_array($dataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
 539               if (in_array($dataType, array('Individual', 'Household', 'Organization'))) {
 540                 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "', 'Contact' ";
 541               }
 542               else {
 543                 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "'";
 544               }
 545               $value = $value ? $value . ", {$val}" : $val;
 546             }
 547           }
 548           if ($value) {
 549             $extends = "AND   $cgTable.extends IN ( $value ) ";
 550           }
 551         }
 552
 553         if (!empty($customDataType) && empty($extends)) {
 554           // $customDataType specified a filter, but there is no corresponding SQL ($extends)
 555           self::$_importFields[$cacheKey] = array();
 556           return self::$_importFields[$cacheKey];
 557         }
 558
 559         if ($onlyParent) {
 560           $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
 561         }
 562
 563         $query = "SELECT $cfTable.id, $cfTable.label,
 564                             $cgTable.title,
 565                             $cfTable.data_type,
 566                             $cfTable.html_type,
 567                             $cfTable.default_value,
 568                             $cfTable.options_per_line, $cfTable.text_length,
 569                             $cfTable.custom_group_id,
 570                             $cfTable.is_required,
 571                             $cfTable.column_name,
 572                             $cgTable.extends, $cfTable.is_search_range,
 573                             $cgTable.extends_entity_column_value,
 574                             $cgTable.extends_entity_column_id,
 575                             $cfTable.is_view,
 576                             $cfTable.option_group_id,
 577                             $cfTable.date_format,
 578                             $cfTable.time_format,
 579                             $cgTable.is_multiple,
 580                             $cgTable.table_name,
 581                             og.name as option_group_name
 582                      FROM $cfTable
 583                      INNER JOIN $cgTable
 584                        ON $cfTable.custom_group_id = $cgTable.id
 585                      LEFT JOIN civicrm_option_group og
 586                        ON $cfTable.option_group_id = og.id
 587                      WHERE ( 1 ) ";
 588
 589         if (!$showAll) {
 590           $query .= " AND $cfTable.is_active = 1 AND $cgTable.is_active = 1 ";
 591         }
 592
 593         if ($inline) {
 594           $query .= " AND $cgTable.style = 'Inline' ";
 595         }
 596
 597         //get the custom fields for specific type in
 598         //combination with fields those support any type.
 599         if (!empty($customDataSubType)) {
 600           $subtypeClause = array();
 601           foreach ($customDataSubType as $subtype) {
 602             $subtype = CRM_Core_DAO::VALUE_SEPARATOR . $subtype . CRM_Core_DAO::VALUE_SEPARATOR;
 603             $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
 604           }
 605           if (!$onlySubType) {
 606             $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
 607           }
 608           $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
 609         }
 610
 611         if ($customDataSubName) {
 612           $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
 613         }
 614
 615         // also get the permission stuff here
 616         if ($checkPermission) {
 617           $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
 618             "{$cgTable}.", TRUE
 619           );
 620         }
 621         else {
 622           $permissionClause = '(1)';
 623         }
 624
 625         $query .= " $extends AND $permissionClause
 626                         ORDER BY $cgTable.weight, $cgTable.title,
 627                                  $cfTable.weight, $cfTable.label";
 628
 629         $dao = CRM_Core_DAO::executeQuery($query);
 630
 631         $fields = array();
 632         while (($dao->fetch()) != NULL) {
 633           $fields[$dao->id]['label'] = $dao->label;
 634           $fields[$dao->id]['groupTitle'] = $dao->title;
 635           $fields[$dao->id]['data_type'] = $dao->data_type;
 636           $fields[$dao->id]['html_type'] = $dao->html_type;
 637           $fields[$dao->id]['default_value'] = $dao->default_value;
 638           $fields[$dao->id]['text_length'] = $dao->text_length;
 639           $fields[$dao->id]['options_per_line'] = $dao->options_per_line;
 640           $fields[$dao->id]['custom_group_id'] = $dao->custom_group_id;
 641           $fields[$dao->id]['extends'] = $dao->extends;
 642           $fields[$dao->id]['is_search_range'] = $dao->is_search_range;
 643           $fields[$dao->id]['extends_entity_column_value'] = $dao->extends_entity_column_value;
 644           $fields[$dao->id]['extends_entity_column_id'] = $dao->extends_entity_column_id;
 645           $fields[$dao->id]['is_view'] = $dao->is_view;
 646           $fields[$dao->id]['is_multiple'] = $dao->is_multiple;
 647           $fields[$dao->id]['option_group_id'] = $dao->option_group_id;
 648           $fields[$dao->id]['date_format'] = $dao->date_format;
 649           $fields[$dao->id]['time_format'] = $dao->time_format;
 650           $fields[$dao->id]['is_required'] = $dao->is_required;
 651           $fields[$dao->id]['table_name'] = $dao->table_name;
 652           $fields[$dao->id]['column_name'] = $dao->column_name;
 653           self::getOptionsForField($fields[$dao->id], $dao->option_group_name);
 654         }
 655
 656         CRM_Core_BAO_Cache::setItem($fields,
 657           'contact fields',
 658           "custom importableFields $cacheKey"
 659         );
 660       }
 661       self::$_importFields[$cacheKey] = $fields;
 662     }
 663
 664     return self::$_importFields[$cacheKey];
 665   }
 666
 667   /**
 668    * Return the field ids and names (with groups) for import purpose.
 669    *
 670    * @param int|string $contactType Contact type
 671    * @param bool $showAll
 672    *   If true returns all fields (includes disabled fields).
 673    * @param bool $onlyParent
 674    *   Return fields ONLY related to basic types.
 675    * @param bool $search
 676    *   When called from search and multiple records need to be returned.
 677    * @param bool $checkPermission
 678    *   If false, do not include permissioning clause.
 679    *
 680    * @param bool $withMultiple
 681    *
 682    * @return array
 683    */
 684   public static function getFieldsForImport(
 685     $contactType = 'Individual',
 686     $showAll = FALSE,
 687     $onlyParent = FALSE,
 688     $search = FALSE,
 689     $checkPermission = TRUE,
 690     $withMultiple = FALSE
 691   ) {
 692     // Note: there are situations when we want getFieldsForImport() return fields related
 693     // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
 694     $fields = &self::getFields($contactType,
 695       $showAll,
 696       FALSE,
 697       NULL,
 698       NULL,
 699       $onlyParent,
 700       FALSE,
 701       $checkPermission
 702     );
 703
 704     $importableFields = array();
 705     foreach ($fields as $id => $values) {
 706       // for now we should not allow multiple fields in profile / export etc, hence unsetting
 707       if (!$search &&
 708         (!empty($values['is_multiple']) && !$withMultiple)
 709       ) {
 710         continue;
 711       }
 712
 713       /* generate the key for the fields array */
 714
 715       $key = "custom_$id";
 716
 717       $regexp = preg_replace('/[.,;:!?]/', '', CRM_Utils_Array::value(0, $values));
 718       $importableFields[$key] = array(
 719         'name' => $key,
 720         'type' => CRM_Utils_Array::value(CRM_Utils_Array::value('data_type', $values), self::dataToType()),
 721         'title' => CRM_Utils_Array::value('label', $values),
 722         'headerPattern' => '/' . preg_quote($regexp, '/') . '/',
 723         'import' => 1,
 724         'custom_field_id' => $id,
 725         'options_per_line' => CRM_Utils_Array::value('options_per_line', $values),
 726         'text_length' => CRM_Utils_Array::value('text_length', $values, 255),
 727         'data_type' => CRM_Utils_Array::value('data_type', $values),
 728         'html_type' => CRM_Utils_Array::value('html_type', $values),
 729         'is_search_range' => CRM_Utils_Array::value('is_search_range', $values),
 730       );
 731
 732       // CRM-6681, pass date and time format when html_type = Select Date
 733       if (CRM_Utils_Array::value('html_type', $values) == 'Select Date') {
 734         $importableFields[$key]['date_format'] = CRM_Utils_Array::value('date_format', $values);
 735         $importableFields[$key]['time_format'] = CRM_Utils_Array::value('time_format', $values);
 736       }
 737     }
 738
 739     return $importableFields;
 740   }
 741
 742   /**
 743    * Get the field id from an import key.
 744    *
 745    * @param string $key
 746    *   The key to parse.
 747    *
 748    * @param bool $all
 749    *
 750    * @return int|null
 751    *   The id (if exists)
 752    */
 753   public static function getKeyID($key, $all = FALSE) {
 754     $match = array();
 755     if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
 756       if (!$all) {
 757         return $match[1];
 758       }
 759       else {
 760         return array(
 761           $match[1],
 762           CRM_Utils_Array::value(2, $match),
 763         );
 764       }
 765     }
 766     return $all ? array(NULL, NULL) : NULL;
 767   }
 768
 769   /**
 770    * Use the cache to get all values of a specific custom field.
 771    *
 772    * @param int $fieldID
 773    *   The custom field ID.
 774    *
 775    * @return CRM_Core_BAO_CustomField
 776    *   The field object.
 777    */
 778   public static function getFieldObject($fieldID) {
 779     $field = new CRM_Core_BAO_CustomField();
 780
 781     // check if we can get the field values from the system cache
 782     $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
 783     $cache = CRM_Utils_Cache::singleton();
 784     $fieldValues = $cache->get($cacheKey);
 785     if (empty($fieldValues)) {
 786       $field->id = $fieldID;
 787       if (!$field->find(TRUE)) {
 788         CRM_Core_Error::fatal();
 789       }
 790
 791       $fieldValues = array();
 792       CRM_Core_DAO::storeValues($field, $fieldValues);
 793
 794       $cache->set($cacheKey, $fieldValues);
 795     }
 796     else {
 797       $field->copyValues($fieldValues);
 798     }
 799
 800     return $field;
 801   }
 802
 803   /**
 804    * Add a custom field to an existing form.
 805    *
 806    * @param CRM_Core_Form $qf
 807    *   Form object (reference).
 808    * @param string $elementName
 809    *   Name of the custom field.
 810    * @param int $fieldId
 811    * @param bool $useRequired
 812    *   True if required else false.
 813    * @param bool $search
 814    *   True if used for search else false.
 815    * @param string $label
 816    *   Label for custom field.
 817    * @return \HTML_QuickForm_Element|null
 818    * @throws \CiviCRM_API3_Exception
 819    */
 820   public static function addQuickFormElement(
 821     $qf, $elementName, $fieldId, $useRequired = TRUE, $search = FALSE, $label = NULL
 822   ) {
 823     $field = self::getFieldObject($fieldId);
 824     $widget = $field->html_type;
 825     $element = NULL;
 826     $customFieldAttributes = array();
 827
 828     // Custom field HTML should indicate group+field name
 829     $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id);
 830     $dataCrmCustomVal = $groupName . ':' . $field->name;
 831     $dataCrmCustomAttr = 'data-crm-custom="' . $dataCrmCustomVal . '"';
 832     $field->attributes .= $dataCrmCustomAttr;
 833
 834     // Fixed for Issue CRM-2183
 835     if ($widget == 'TextArea' && $search) {
 836       $widget = 'Text';
 837     }
 838
 839     $placeholder = $search ? ts('- any -') : ($useRequired ? ts('- select -') : ts('- none -'));
 840
 841     // FIXME: Why are select state/country separate widget types?
 842     $isSelect = (in_array($widget, array(
 843       'Select',
 844       'Multi-Select',
 845       'Select State/Province',
 846       'Multi-Select State/Province',
 847       'Select Country',
 848       'Multi-Select Country',
 849       'CheckBox',
 850       'Radio',
 851     )));
 852
 853     if ($isSelect) {
 854       $options = $field->getOptions($search ? 'search' : 'create');
 855
 856       // Consolidate widget types to simplify the below switch statement
 857       if ($search || (strpos($widget, 'Select') !== FALSE)) {
 858         $widget = 'Select';
 859       }
 860
 861       $customFieldAttributes['data-crm-custom'] = $dataCrmCustomVal;
 862       $selectAttributes = array('class' => 'crm-select2');
 863
 864       // Search field is always multi-select
 865       if ($search || strpos($field->html_type, 'Multi') !== FALSE) {
 866         $selectAttributes['class'] .= ' huge';
 867         $selectAttributes['multiple'] = 'multiple';
 868         $selectAttributes['placeholder'] = $placeholder;
 869       }
 870
 871       // Add data for popup link. Normally this is handled by CRM_Core_Form->addSelect
 872       $isSupportedWidget = in_array($widget, ['Select', 'Radio']);
 873       $canEditOptions = CRM_Core_Permission::check('administer CiviCRM');
 874       if ($field->option_group_id && !$search && $isSelect && $canEditOptions) {
 875         $customFieldAttributes += array(
 876           'data-api-entity' => $field->getEntity(),
 877           'data-api-field' => 'custom_' . $field->id,
 878           'data-option-edit-path' => 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $field->option_group_id),
 879         );
 880         $selectAttributes += $customFieldAttributes;
 881       }
 882     }
 883
 884     $rangeDataTypes = ['Int', 'Float', 'Money'];
 885
 886     if (!isset($label)) {
 887       $label = $field->label;
 888     }
 889
 890     // at some point in time we might want to split the below into small functions
 891
 892     switch ($widget) {
 893       case 'Text':
 894       case 'Link':
 895         if ($field->is_search_range && $search && in_array($field->data_type, $rangeDataTypes)) {
 896           $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
 897           $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
 898         }
 899         else {
 900           if ($field->text_length) {
 901             $field->attributes .= ' maxlength=' . $field->text_length;
 902             if ($field->text_length < 20) {
 903               $field->attributes .= ' size=' . $field->text_length;
 904             }
 905           }
 906           $element = $qf->add('text', $elementName, $label,
 907             $field->attributes,
 908             $useRequired && !$search
 909           );
 910         }
 911         break;
 912
 913       case 'TextArea':
 914         $attributes = $dataCrmCustomAttr;
 915         if ($field->note_rows) {
 916           $attributes .= 'rows=' . $field->note_rows;
 917         }
 918         else {
 919           $attributes .= 'rows=4';
 920         }
 921         if ($field->note_columns) {
 922           $attributes .= ' cols=' . $field->note_columns;
 923         }
 924         else {
 925           $attributes .= ' cols=60';
 926         }
 927         if ($field->text_length) {
 928           $attributes .= ' maxlength=' . $field->text_length;
 929         }
 930         $element = $qf->add('textarea',
 931           $elementName,
 932           $label,
 933           $attributes,
 934           $useRequired && !$search
 935         );
 936         break;
 937
 938       case 'Select Date':
 939         $attr = array('data-crm-custom' => $dataCrmCustomVal);
 940         //CRM-18379: Fix for date range of 'Select Date' custom field when include in profile.
 941         $minYear = isset($field->start_date_years) ? (date('Y') - $field->start_date_years) : NULL;
 942         $maxYear = isset($field->end_date_years) ? (date('Y') + $field->end_date_years) : NULL;
 943
 944         $params = array(
 945           'date' => $field->date_format,
 946           'minDate' => isset($minYear) ? $minYear . '-01-01' : NULL,
 947           //CRM-18487 - max date should be the last date of the year.
 948           'maxDate' => isset($maxYear) ? $maxYear . '-12-31' : NULL,
 949           'time' => $field->time_format ? $field->time_format * 12 : FALSE,
 950         );
 951         if ($field->is_search_range && $search) {
 952           $qf->add('datepicker', $elementName . '_from', $label, $attr + array('placeholder' => ts('From')), FALSE, $params);
 953           $qf->add('datepicker', $elementName . '_to', NULL, $attr + array('placeholder' => ts('To')), FALSE, $params);
 954         }
 955         else {
 956           $element = $qf->add('datepicker', $elementName, $label, $attr, $useRequired && !$search, $params);
 957         }
 958         break;
 959
 960       case 'Radio':
 961         if ($field->is_search_range && $search && in_array($field->data_type, $rangeDataTypes)) {
 962           $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
 963           $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
 964         }
 965         else {
 966           $choice = array();
 967           parse_str($field->attributes, $radioAttributes);
 968           $radioAttributes = array_merge($radioAttributes, $customFieldAttributes);
 969
 970           foreach ($options as $v => $l) {
 971             $choice[] = $qf->createElement('radio', NULL, '', $l, (string) $v, $radioAttributes);
 972           }
 973           $element = $qf->addGroup($choice, $elementName, $label);
 974           $optionEditKey = 'data-option-edit-path';
 975           if (isset($selectAttributes[$optionEditKey])) {
 976             $element->setAttribute($optionEditKey, $selectAttributes[$optionEditKey]);
 977           }
 978
 979           if ($useRequired && !$search) {
 980             $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
 981           }
 982           else {
 983             $element->setAttribute('allowClear', TRUE);
 984           }
 985         }
 986         break;
 987
 988       // For all select elements
 989       case 'Select':
 990         if ($field->is_search_range && $search && in_array($field->data_type, $rangeDataTypes)) {
 991           $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
 992           $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
 993         }
 994         else {
 995           if (empty($selectAttributes['multiple'])) {
 996             $options = array('' => $placeholder) + $options;
 997           }
 998           $element = $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $selectAttributes);
 999
1000           // Add and/or option for fields that store multiple values
1001           if ($search && self::isSerialized($field)) {
1002
1003             $operators = array(
1004               $qf->createElement('radio', NULL, '', ts('Any'), 'or', array('title' => ts('Results may contain any of the selected options'))),
1005               $qf->createElement('radio', NULL, '', ts('All'), 'and', array('title' => ts('Results must have all of the selected options'))),
1006             );
1007             $qf->addGroup($operators, $elementName . '_operator');
1008             $qf->setDefaults(array($elementName . '_operator' => 'or'));
1009           }
1010         }
1011         break;
1012
1013       case 'CheckBox':
1014         $check = array();
1015         foreach ($options as $v => $l) {
1016           $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, $customFieldAttributes);
1017         }
1018
1019         $group = $element = $qf->addGroup($check, $elementName, $label);
1020         $optionEditKey = 'data-option-edit-path';
1021         if (isset($customFieldAttributes[$optionEditKey])) {
1022           $group->setAttribute($optionEditKey, $customFieldAttributes[$optionEditKey]);
1023         }
1024
1025         if ($useRequired && !$search) {
1026           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
1027         }
1028         break;
1029
1030       case 'File':
1031         // we should not build upload file in search mode
1032         if ($search) {
1033           return NULL;
1034         }
1035         $element = $qf->add(
1036           strtolower($field->html_type),
1037           $elementName,
1038           $label,
1039           $field->attributes,
1040           $useRequired && !$search
1041         );
1042         $qf->addUploadElement($elementName);
1043         break;
1044
1045       case 'RichTextEditor':
1046         $attributes = array(
1047           'rows' => $field->note_rows,
1048           'cols' => $field->note_columns,
1049           'data-crm-custom' => $dataCrmCustomVal,
1050         );
1051         if ($field->text_length) {
1052           $attributes['maxlength'] = $field->text_length;
1053         }
1054         $element = $qf->add('wysiwyg', $elementName, $label, $attributes, $useRequired && !$search);
1055         break;
1056
1057       case 'Autocomplete-Select':
1058         static $customUrls = array();
1059         // Fixme: why is this a string in the first place??
1060         $attributes = array();
1061         if ($field->attributes) {
1062           foreach (explode(' ', $field->attributes) as $at) {
1063             if (strpos($at, '=')) {
1064               list($k, $v) = explode('=', $at);
1065               $attributes[$k] = trim($v, ' "');
1066             }
1067           }
1068         }
1069         if ($field->data_type == 'ContactReference') {
1070           // break if contact does not have permission to access ContactReference
1071           if (!CRM_Core_Permission::check('access contact reference fields')) {
1072             break;
1073           }
1074           $attributes['class'] = (isset($attributes['class']) ? $attributes['class'] . ' ' : '') . 'crm-form-contact-reference huge';
1075           $attributes['data-api-entity'] = 'Contact';
1076           $element = $qf->add('text', $elementName, $label, $attributes, $useRequired && !$search);
1077
1078           $urlParams = "context=customfield&id={$field->id}";
1079           $idOfelement = $elementName;
1080           // dev/core#362 if in an onbehalf profile clean up the name to get rid of square brackets that break the select 2 js
1081           // However this caused regression https://lab.civicrm.org/dev/core/issues/619 so it has been hacked back to
1082           // only affecting on behalf - next time someone looks at this code it should be with a view to overhauling it
1083           // rather than layering on more hacks.
1084           if (substr($elementName, 0, 8) === 'onbehalf' && strpos($elementName, '[') && strpos($elementName, ']')) {
1085             $idOfelement = substr(substr($elementName, (strpos($elementName, '[') + 1)), 0, -1);
1086           }
1087           $customUrls[$idOfelement] = CRM_Utils_System::url('civicrm/ajax/contactref',
1088             $urlParams,
1089             FALSE, NULL, FALSE
1090           );
1091
1092         }
1093         else {
1094           // FIXME: This won't work with customFieldOptions hook
1095           $attributes += array(
1096             'entity' => 'OptionValue',
1097             'placeholder' => $placeholder,
1098             'multiple' => $search,
1099             'api' => array(
1100               'params' => array('option_group_id' => $field->option_group_id),
1101             ),
1102           );
1103           $element = $qf->addEntityRef($elementName, $label, $attributes, $useRequired && !$search);
1104         }
1105
1106         $qf->assign('customUrls', $customUrls);
1107         break;
1108     }
1109
1110     switch ($field->data_type) {
1111       case 'Int':
1112         // integers will have numeric rule applied to them.
1113         if ($field->is_search_range && $search) {
1114           $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1115           $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1116         }
1117         elseif ($widget == 'Text') {
1118           $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1119         }
1120         break;
1121
1122       case 'Float':
1123         if ($field->is_search_range && $search) {
1124           $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1125           $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1126         }
1127         elseif ($widget == 'Text') {
1128           $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1129         }
1130         break;
1131
1132       case 'Money':
1133         if ($field->is_search_range && $search) {
1134           $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1135           $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1136         }
1137         elseif ($widget == 'Text') {
1138           $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1139         }
1140         break;
1141
1142       case 'Link':
1143         $element->setAttribute('class', "url");
1144         $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
1145         break;
1146     }
1147     if ($field->is_view && !$search) {
1148       $qf->freeze($elementName);
1149     }
1150     return $element;
1151   }
1152
1153   /**
1154    * Delete the Custom Field.
1155    *
1156    * @param object $field
1157    *   The field object.
1158    */
1159   public static function deleteField($field) {
1160     CRM_Utils_System::flushCache();
1161
1162     // first delete the custom option group and values associated with this field
1163     if ($field->option_group_id) {
1164       //check if option group is related to any other field, if
1165       //not delete the option group and related option values
1166       self::checkOptionGroup($field->option_group_id);
1167     }
1168
1169     // next drop the column from the custom value table
1170     self::createField($field, 'delete');
1171
1172     $field->delete();
1173     CRM_Core_BAO_UFField::delUFField($field->id);
1174     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1175
1176     CRM_Utils_Hook::post('delete', 'CustomField', $field->id, $field);
1177   }
1178
1179   /**
1180    * @param string|int|array|null $value
1181    * @param CRM_Core_BAO_CustomField|int|array|string $field
1182    * @param int $entityId
1183    *
1184    * @return string
1185    * @throws \Exception
1186    */
1187   public static function displayValue($value, $field, $entityId = NULL) {
1188     $field = is_array($field) ? $field['id'] : $field;
1189     $fieldId = is_object($field) ? $field->id : (int) str_replace('custom_', '', $field);
1190
1191     if (!$fieldId) {
1192       throw new Exception('CRM_Core_BAO_CustomField::displayValue requires a field id');
1193     }
1194
1195     if (!is_a($field, 'CRM_Core_BAO_CustomField')) {
1196       $field = self::getFieldObject($fieldId);
1197     }
1198
1199     $fieldInfo = array('options' => $field->getOptions()) + (array) $field;
1200
1201     return self::formatDisplayValue($value, $fieldInfo, $entityId);
1202   }
1203
1204   /**
1205    * Lower-level logic for rendering a custom field value
1206    *
1207    * @param string|array $value
1208    * @param array $field
1209    * @param int|null $entityId
1210    *
1211    * @return string
1212    */
1213   private static function formatDisplayValue($value, $field, $entityId = NULL) {
1214
1215     if (self::isSerialized($field) && !is_array($value)) {
1216       $value = CRM_Utils_Array::explodePadded($value);
1217     }
1218     // CRM-12989 fix
1219     if ($field['html_type'] == 'CheckBox') {
1220       CRM_Utils_Array::formatArrayKeys($value);
1221     }
1222
1223     $display = is_array($value) ? implode(', ', $value) : (string) $value;
1224
1225     switch ($field['html_type']) {
1226
1227       case 'Select':
1228       case 'Autocomplete-Select':
1229       case 'Radio':
1230       case 'Select Country':
1231       case 'Select State/Province':
1232       case 'CheckBox':
1233       case 'Multi-Select':
1234       case 'Multi-Select State/Province':
1235       case 'Multi-Select Country':
1236         if ($field['data_type'] == 'ContactReference' && $value) {
1237           if (is_numeric($value)) {
1238             $display = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1239           }
1240           else {
1241             $display = $value;
1242           }
1243         }
1244         elseif (is_array($value)) {
1245           $v = array();
1246           foreach ($value as $key => $val) {
1247             $v[] = CRM_Utils_Array::value($val, $field['options']);
1248           }
1249           $display = implode(', ', $v);
1250         }
1251         else {
1252           $display = CRM_Utils_Array::value($value, $field['options'], '');
1253         }
1254         break;
1255
1256       case 'Select Date':
1257         $customFormat = NULL;
1258
1259         // FIXME: Are there any legitimate reasons why $value would be an array?
1260         // Or should we throw an exception here if it is?
1261         $value = is_array($value) ? CRM_Utils_Array::first($value) : $value;
1262
1263         $actualPHPFormats = CRM_Utils_Date::datePluginToPHPFormats();
1264         $format = CRM_Utils_Array::value('date_format', $field);
1265
1266         if ($format) {
1267           if (array_key_exists($format, $actualPHPFormats)) {
1268             $customTimeFormat = (array) $actualPHPFormats[$format];
1269             switch (CRM_Utils_Array::value('time_format', $field)) {
1270               case 1:
1271                 $customTimeFormat[] = 'g:iA';
1272                 break;
1273
1274               case 2:
1275                 $customTimeFormat[] = 'G:i';
1276                 break;
1277
1278               default:
1279                 //If time is not selected remove time from value.
1280                 $value = $value ? date('Y-m-d', strtotime($value)) : '';
1281             }
1282             $customFormat = implode(" ", $customTimeFormat);
1283           }
1284         }
1285         $display = CRM_Utils_Date::processDate($value, NULL, FALSE, $customFormat);
1286         break;
1287
1288       case 'File':
1289         // In the context of displaying a profile, show file/image
1290         if ($value) {
1291           if ($entityId) {
1292             if (CRM_Utils_Rule::positiveInteger($value)) {
1293               $fileId = $value;
1294             }
1295             else {
1296               $fileId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File', $value, 'id', 'uri');
1297             }
1298             $url = self::getFileURL($entityId, $field['id'], $fileId);
1299             if ($url) {
1300               $display = $url['file_url'];
1301             }
1302           }
1303           else {
1304             // In other contexts show a paperclip icon
1305             if (CRM_Utils_Rule::integer($value)) {
1306               $icons = CRM_Core_BAO_File::paperIconAttachment('*', $value);
1307               $display = $icons[$value];
1308             }
1309             else {
1310               //CRM-18396, if filename is passed instead
1311               $display = $value;
1312             }
1313           }
1314         }
1315         break;
1316
1317       case 'Link':
1318         $display = $display ? "<a href=\"$display\" target=\"_blank\">$display</a>" : $display;
1319         break;
1320
1321       case 'TextArea':
1322         $display = nl2br($display);
1323         break;
1324
1325       case 'Text':
1326         if ($field['data_type'] == 'Money' && isset($value)) {
1327           // $value can also be an array(while using IN operator from search builder or api).
1328           foreach ((array) $value as $val) {
1329             $disp[] = CRM_Utils_Money::format($val, NULL, NULL, TRUE);
1330           }
1331           $display = implode(', ', $disp);
1332         }
1333         break;
1334     }
1335     return $display;
1336   }
1337
1338   /**
1339    * Set default values for custom data used in profile.
1340    *
1341    * @param int $customFieldId
1342    *   Custom field id.
1343    * @param string $elementName
1344    *   Custom field name.
1345    * @param array $defaults
1346    *   Associated array of fields.
1347    * @param int $contactId
1348    *   Contact id.
1349    * @param int $mode
1350    *   Profile mode.
1351    * @param mixed $value
1352    *   If passed - dont fetch value from db,.
1353    *                               just format the given value
1354    */
1355   public static function setProfileDefaults(
1356     $customFieldId,
1357     $elementName,
1358     &$defaults,
1359     $contactId = NULL,
1360     $mode = NULL,
1361     $value = NULL
1362   ) {
1363     //get the type of custom field
1364     $customField = new CRM_Core_BAO_CustomField();
1365     $customField->id = $customFieldId;
1366     $customField->find(TRUE);
1367
1368     if (!$contactId) {
1369       if ($mode == CRM_Profile_Form::MODE_CREATE) {
1370         $value = $customField->default_value;
1371       }
1372     }
1373     else {
1374       if (!isset($value)) {
1375         $info = self::getTableColumnGroup($customFieldId);
1376         $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1377         $result = CRM_Core_DAO::executeQuery($query);
1378         if ($result->fetch()) {
1379           $value = $result->value;
1380         }
1381       }
1382
1383       if ($customField->data_type == 'Country') {
1384         if (!$value) {
1385           $config = CRM_Core_Config::singleton();
1386           if ($config->defaultContactCountry) {
1387             $value = $config->defaultContactCountry();
1388           }
1389         }
1390       }
1391     }
1392
1393     //set defaults if mode is registration
1394     if (!trim($value) &&
1395       ($value !== 0) &&
1396       (!in_array($mode, array(CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)))
1397     ) {
1398       $value = $customField->default_value;
1399     }
1400
1401     if ($customField->data_type == 'Money' && isset($value)) {
1402       $value = number_format($value, 2);
1403     }
1404     switch ($customField->html_type) {
1405       case 'CheckBox':
1406       case 'Multi-Select':
1407         $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldId, FALSE);
1408         $defaults[$elementName] = array();
1409         $checkedValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1410           substr($value, 1, -1)
1411         );
1412         foreach ($customOption as $val) {
1413           if (in_array($val['value'], $checkedValue)) {
1414             if ($customField->html_type == 'CheckBox') {
1415               $defaults[$elementName][$val['value']] = 1;
1416             }
1417             elseif ($customField->html_type == 'Multi-Select') {
1418               $defaults[$elementName][$val['value']] = $val['value'];
1419             }
1420           }
1421         }
1422         break;
1423
1424       case 'Autocomplete-Select':
1425         if ($customField->data_type == 'ContactReference') {
1426           if (is_numeric($value)) {
1427             $defaults[$elementName . '_id'] = $value;
1428             $defaults[$elementName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1429           }
1430         }
1431         else {
1432           $defaults[$elementName] = $value;
1433         }
1434         break;
1435
1436       default:
1437         $defaults[$elementName] = $value;
1438     }
1439   }
1440
1441   /**
1442    * Get file url.
1443    *
1444    * @param int $contactID
1445    * @param int $cfID
1446    * @param int $fileID
1447    * @param bool $absolute
1448    *
1449    * @param string $multiRecordWhereClause
1450    *
1451    * @return array
1452    */
1453   public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1454     if ($contactID) {
1455       if (!$fileID) {
1456         $params = array('id' => $cfID);
1457         $defaults = array();
1458         CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1459         $columnName = $defaults['column_name'];
1460
1461         //table name of custom data
1462         $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
1463           $defaults['custom_group_id'],
1464           'table_name', 'id'
1465         );
1466
1467         //query to fetch id from civicrm_file
1468         if ($multiRecordWhereClause) {
1469           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1470         }
1471         else {
1472           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1473         }
1474         $fileID = CRM_Core_DAO::singleValueQuery($query);
1475       }
1476
1477       $result = array();
1478       if ($fileID) {
1479         $fileType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1480           $fileID,
1481           'mime_type',
1482           'id'
1483         );
1484         $result['file_id'] = $fileID;
1485
1486         if ($fileType == 'image/jpeg' ||
1487           $fileType == 'image/pjpeg' ||
1488           $fileType == 'image/gif' ||
1489           $fileType == 'image/x-png' ||
1490           $fileType == 'image/png'
1491         ) {
1492           $entityId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile',
1493             $fileID,
1494             'entity_id',
1495             'file_id'
1496           );
1497           list($path) = CRM_Core_BAO_File::path($fileID, $entityId);
1498           $fileHash = CRM_Core_BAO_File::generateFileHash($entityId, $fileID);
1499           $url = CRM_Utils_System::url('civicrm/file',
1500             "reset=1&id=$fileID&eid=$entityId&fcs=$fileHash",
1501             $absolute, NULL, TRUE, TRUE
1502           );
1503           $result['file_url'] = CRM_Utils_File::getFileURL($path, $fileType, $url);
1504         }
1505         // for non image files
1506         else {
1507           $uri = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1508             $fileID,
1509             'uri'
1510           );
1511           $fileHash = CRM_Core_BAO_File::generateFileHash($contactID, $fileID);
1512           $url = CRM_Utils_System::url('civicrm/file',
1513             "reset=1&id=$fileID&eid=$contactID&fcs=$fileHash",
1514             $absolute, NULL, TRUE, TRUE
1515           );
1516           $result['file_url'] = CRM_Utils_File::getFileURL($uri, $fileType, $url);
1517         }
1518       }
1519       return $result;
1520     }
1521   }
1522
1523   /**
1524    * Format custom fields before inserting.
1525    *
1526    * @param int $customFieldId
1527    *   Custom field id.
1528    * @param array $customFormatted
1529    *   Formatted array.
1530    * @param mixed $value
1531    *   Value of custom field.
1532    * @param string $customFieldExtend
1533    *   Custom field extends.
1534    * @param int $customValueId
1535    *   Custom option value id.
1536    * @param int $entityId
1537    *   Entity id (contribution, membership...).
1538    * @param bool $inline
1539    *   Consider inline custom groups only.
1540    * @param bool $checkPermission
1541    *   If false, do not include permissioning clause.
1542    * @param bool $includeViewOnly
1543    *   If true, fields marked 'View Only' are included. Required for APIv3.
1544    *
1545    * @return array|NULL
1546    *   formatted custom field array
1547    */
1548   public static function formatCustomField(
1549     $customFieldId, &$customFormatted, $value,
1550     $customFieldExtend, $customValueId = NULL,
1551     $entityId = NULL,
1552     $inline = FALSE,
1553     $checkPermission = TRUE,
1554     $includeViewOnly = FALSE
1555   ) {
1556     //get the custom fields for the entity
1557     //subtype and basic type
1558     $customDataSubType = NULL;
1559     if ($customFieldExtend) {
1560       // This is the case when getFieldsForImport() requires fields
1561       // of subtype and its parent.CRM-5143
1562       // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1563       $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType::subTypes(), (array) $customFieldExtend);
1564       if (!empty($customDataSubType) && is_array($customDataSubType)) {
1565         $customFieldExtend = CRM_Contact_BAO_ContactType::getBasicType($customDataSubType);
1566         if (is_array($customFieldExtend)) {
1567           $customFieldExtend = array_unique(array_values($customFieldExtend));
1568         }
1569       }
1570     }
1571
1572     $customFields = CRM_Core_BAO_CustomField::getFields($customFieldExtend,
1573       FALSE,
1574       $inline,
1575       $customDataSubType,
1576       NULL,
1577       FALSE,
1578       FALSE,
1579       $checkPermission
1580     );
1581
1582     if (!array_key_exists($customFieldId, $customFields)) {
1583       return NULL;
1584     }
1585
1586     // return if field is a 'code' field
1587     if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1588       return NULL;
1589     }
1590
1591     list($tableName, $columnName, $groupID) = self::getTableColumnGroup($customFieldId);
1592
1593     if (!$customValueId &&
1594       // we always create new entites for is_multiple unless specified
1595       !$customFields[$customFieldId]['is_multiple'] &&
1596       $entityId
1597     ) {
1598       $query = "
1599 SELECT id
1600   FROM $tableName
1601  WHERE entity_id={$entityId}";
1602
1603       $customValueId = CRM_Core_DAO::singleValueQuery($query);
1604     }
1605
1606     //fix checkbox, now check box always submits values
1607     if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1608       if ($value) {
1609         // Note that only during merge this is not an array, and you can directly use value
1610         if (is_array($value)) {
1611           $selectedValues = array();
1612           foreach ($value as $selId => $val) {
1613             if ($val) {
1614               $selectedValues[] = $selId;
1615             }
1616           }
1617           if (!empty($selectedValues)) {
1618             $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1619                 $selectedValues
1620               ) . CRM_Core_DAO::VALUE_SEPARATOR;
1621           }
1622           else {
1623             $value = '';
1624           }
1625         }
1626       }
1627     }
1628
1629     if ($customFields[$customFieldId]['html_type'] == 'Multi-Select') {
1630       if ($value) {
1631         $value = CRM_Utils_Array::implodePadded($value);
1632       }
1633       else {
1634         $value = '';
1635       }
1636     }
1637
1638     if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1639         $customFields[$customFieldId]['html_type'] == 'CheckBox'
1640       ) &&
1641       $customFields[$customFieldId]['data_type'] == 'String' &&
1642       !empty($customFields[$customFieldId]['text_length']) &&
1643       !empty($value)
1644     ) {
1645       // lets make sure that value is less than the length, else we'll
1646       // be losing some data, CRM-7481
1647       if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1648         // need to do a few things here
1649
1650         // 1. lets find a new length
1651         $newLength = $customFields[$customFieldId]['text_length'];
1652         $minLength = strlen($value);
1653         while ($newLength < $minLength) {
1654           $newLength = $newLength * 2;
1655         }
1656
1657         // set the custom field meta data to have a length larger than value
1658         // alter the custom value table column to match this length
1659         CRM_Core_BAO_SchemaHandler::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1660       }
1661     }
1662
1663     $date = NULL;
1664     if ($customFields[$customFieldId]['data_type'] == 'Date') {
1665       if (!CRM_Utils_System::isNull($value)) {
1666         $format = $customFields[$customFieldId]['date_format'];
1667         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, 'YmdHis', $format);
1668       }
1669       $value = $date;
1670     }
1671
1672     if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1673       $customFields[$customFieldId]['data_type'] == 'Money'
1674     ) {
1675       if (!$value) {
1676         $value = 0;
1677       }
1678
1679       if ($customFields[$customFieldId]['data_type'] == 'Money') {
1680         $value = CRM_Utils_Rule::cleanMoney($value);
1681       }
1682     }
1683
1684     if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1685         $customFields[$customFieldId]['data_type'] == 'Country'
1686       ) &&
1687       empty($value)
1688     ) {
1689       // CRM-3415
1690       $value = 0;
1691     }
1692
1693     $fileID = NULL;
1694
1695     if ($customFields[$customFieldId]['data_type'] == 'File') {
1696       if (empty($value)) {
1697         return;
1698       }
1699
1700       $config = CRM_Core_Config::singleton();
1701
1702       // If we are already passing the file id as a value then retrieve and set the file data
1703       if (CRM_Utils_Rule::integer($value)) {
1704         $fileDAO = new CRM_Core_DAO_File();
1705         $fileDAO->id = $value;
1706         $fileDAO->find(TRUE);
1707         if ($fileDAO->N) {
1708           $fileID = $value;
1709           $fName = $fileDAO->uri;
1710           $mimeType = $fileDAO->mime_type;
1711         }
1712       }
1713       else {
1714         $fName = $value['name'];
1715         $mimeType = $value['type'];
1716       }
1717
1718       $filename = pathinfo($fName, PATHINFO_BASENAME);
1719
1720       // rename this file to go into the secure directory only if
1721       // user has uploaded new file not existing verfied on the basis of $fileID
1722       if (empty($fileID) && !rename($fName, $config->customFileUploadDir . $filename)) {
1723         CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory'));
1724       }
1725
1726       if ($customValueId && empty($fileID)) {
1727         $query = "
1728 SELECT $columnName
1729   FROM $tableName
1730  WHERE id = %1";
1731         $params = array(1 => array($customValueId, 'Integer'));
1732         $fileID = CRM_Core_DAO::singleValueQuery($query, $params);
1733       }
1734
1735       $fileDAO = new CRM_Core_DAO_File();
1736
1737       if ($fileID) {
1738         $fileDAO->id = $fileID;
1739       }
1740
1741       $fileDAO->uri = $filename;
1742       $fileDAO->mime_type = $mimeType;
1743       $fileDAO->upload_date = date('YmdHis');
1744       $fileDAO->save();
1745       $fileID = $fileDAO->id;
1746       $value = $filename;
1747     }
1748
1749     if (!is_array($customFormatted)) {
1750       $customFormatted = array();
1751     }
1752
1753     if (!array_key_exists($customFieldId, $customFormatted)) {
1754       $customFormatted[$customFieldId] = array();
1755     }
1756
1757     $index = -1;
1758     if ($customValueId) {
1759       $index = $customValueId;
1760     }
1761
1762     if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1763       $customFormatted[$customFieldId][$index] = array();
1764     }
1765     $customFormatted[$customFieldId][$index] = array(
1766       'id' => $customValueId > 0 ? $customValueId : NULL,
1767       'value' => $value,
1768       'type' => $customFields[$customFieldId]['data_type'],
1769       'custom_field_id' => $customFieldId,
1770       'custom_group_id' => $groupID,
1771       'table_name' => $tableName,
1772       'column_name' => $columnName,
1773       'file_id' => $fileID,
1774       'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1775     );
1776
1777     //we need to sort so that custom fields are created in the order of entry
1778     krsort($customFormatted[$customFieldId]);
1779     return $customFormatted;
1780   }
1781
1782   /**
1783    * Get default custom table schema.
1784    *
1785    * @param array $params
1786    *
1787    * @return array
1788    */
1789   public static function defaultCustomTableSchema($params) {
1790     // add the id and extends_id
1791     $table = array(
1792       'name' => $params['name'],
1793       'is_multiple' => $params['is_multiple'],
1794       'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1795       'fields' => array(
1796         array(
1797           'name' => 'id',
1798           'type' => 'int unsigned',
1799           'primary' => TRUE,
1800           'required' => TRUE,
1801           'attributes' => 'AUTO_INCREMENT',
1802           'comment' => 'Default MySQL primary key',
1803         ),
1804         array(
1805           'name' => 'entity_id',
1806           'type' => 'int unsigned',
1807           'required' => TRUE,
1808           'comment' => 'Table that this extends',
1809           'fk_table_name' => $params['extends_name'],
1810           'fk_field_name' => 'id',
1811           'fk_attributes' => 'ON DELETE CASCADE',
1812         ),
1813       ),
1814     );
1815
1816     if (!$params['is_multiple']) {
1817       $table['indexes'] = array(
1818         array(
1819           'unique' => TRUE,
1820           'field_name_1' => 'entity_id',
1821         ),
1822       );
1823     }
1824     return $table;
1825   }
1826
1827   /**
1828    * Create custom field.
1829    *
1830    * @param CRM_Core_DAO_CustomField $field
1831    * @param string $operation
1832    * @param bool $indexExist
1833    * @param bool $triggerRebuild
1834    */
1835   public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1836     $tableName = CRM_Core_DAO::getFieldValue(
1837       'CRM_Core_DAO_CustomGroup',
1838       $field->custom_group_id,
1839       'table_name'
1840     );
1841
1842     $params = array(
1843       'table_name' => $tableName,
1844       'operation' => $operation,
1845       'name' => $field->column_name,
1846       'type' => CRM_Core_BAO_CustomValueTable::fieldToSQLType(
1847         $field->data_type,
1848         $field->text_length
1849       ),
1850       'required' => $field->is_required,
1851       'searchable' => $field->is_searchable,
1852     );
1853
1854     if ($operation == 'delete') {
1855       $fkName = "{$tableName}_{$field->column_name}";
1856       if (strlen($fkName) >= 48) {
1857         $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1858       }
1859       $params['fkName'] = $fkName;
1860     }
1861     if ($field->data_type == 'Country' && $field->html_type == 'Select Country') {
1862       $params['fk_table_name'] = 'civicrm_country';
1863       $params['fk_field_name'] = 'id';
1864       $params['fk_attributes'] = 'ON DELETE SET NULL';
1865     }
1866     elseif ($field->data_type == 'Country' && $field->html_type == 'Multi-Select Country') {
1867       $params['type'] = 'varchar(255)';
1868     }
1869     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Select State/Province') {
1870       $params['fk_table_name'] = 'civicrm_state_province';
1871       $params['fk_field_name'] = 'id';
1872       $params['fk_attributes'] = 'ON DELETE SET NULL';
1873     }
1874     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Multi-Select State/Province') {
1875       $params['type'] = 'varchar(255)';
1876     }
1877     elseif ($field->data_type == 'File') {
1878       $params['fk_table_name'] = 'civicrm_file';
1879       $params['fk_field_name'] = 'id';
1880       $params['fk_attributes'] = 'ON DELETE SET NULL';
1881     }
1882     elseif ($field->data_type == 'ContactReference') {
1883       $params['fk_table_name'] = 'civicrm_contact';
1884       $params['fk_field_name'] = 'id';
1885       $params['fk_attributes'] = 'ON DELETE SET NULL';
1886     }
1887     if (isset($field->default_value)) {
1888       $params['default'] = "'{$field->default_value}'";
1889     }
1890
1891     CRM_Core_BAO_SchemaHandler::alterFieldSQL($params, $indexExist, $triggerRebuild);
1892   }
1893
1894   /**
1895    * Determine whether it would be safe to move a field.
1896    *
1897    * @param int $fieldID
1898    *   FK to civicrm_custom_field.
1899    * @param int $newGroupID
1900    *   FK to civicrm_custom_group.
1901    *
1902    * @return array
1903    *   array(string) or TRUE
1904    */
1905   public static function _moveFieldValidate($fieldID, $newGroupID) {
1906     $errors = array();
1907
1908     $field = new CRM_Core_DAO_CustomField();
1909     $field->id = $fieldID;
1910     if (!$field->find(TRUE)) {
1911       $errors['fieldID'] = 'Invalid ID for custom field';
1912       return $errors;
1913     }
1914
1915     $oldGroup = new CRM_Core_DAO_CustomGroup();
1916     $oldGroup->id = $field->custom_group_id;
1917     if (!$oldGroup->find(TRUE)) {
1918       $errors['fieldID'] = 'Invalid ID for old custom group';
1919       return $errors;
1920     }
1921
1922     $newGroup = new CRM_Core_DAO_CustomGroup();
1923     $newGroup->id = $newGroupID;
1924     if (!$newGroup->find(TRUE)) {
1925       $errors['newGroupID'] = 'Invalid ID for new custom group';
1926       return $errors;
1927     }
1928
1929     $query = "
1930 SELECT     b.id
1931 FROM       civicrm_custom_field a
1932 INNER JOIN civicrm_custom_field b
1933 WHERE      a.id = %1
1934 AND        a.label = b.label
1935 AND        b.custom_group_id = %2
1936 ";
1937     $params = array(
1938       1 => array($field->id, 'Integer'),
1939       2 => array($newGroup->id, 'Integer'),
1940     );
1941     $count = CRM_Core_DAO::singleValueQuery($query, $params);
1942     if ($count > 0) {
1943       $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1944     }
1945
1946     $tableName = $oldGroup->table_name;
1947     $columnName = $field->column_name;
1948
1949     $query = "
1950 SELECT count(*)
1951 FROM   $tableName
1952 WHERE  $columnName is not null
1953 ";
1954     $count = CRM_Core_DAO::singleValueQuery($query,
1955       CRM_Core_DAO::$_nullArray
1956     );
1957     if ($count > 0) {
1958       $query = "
1959 SELECT extends
1960 FROM   civicrm_custom_group
1961 WHERE  id IN ( %1, %2 )
1962 ";
1963       $params = array(
1964         1 => array($oldGroup->id, 'Integer'),
1965         2 => array($newGroup->id, 'Integer'),
1966       );
1967
1968       $dao = CRM_Core_DAO::executeQuery($query, $params);
1969       $extends = array();
1970       while ($dao->fetch()) {
1971         $extends[] = $dao->extends;
1972       }
1973       if ($extends[0] != $extends[1]) {
1974         $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1975       }
1976     }
1977
1978     return empty($errors) ? TRUE : $errors;
1979   }
1980
1981   /**
1982    * Move a custom data field from one group (table) to another.
1983    *
1984    * @param int $fieldID
1985    *   FK to civicrm_custom_field.
1986    * @param int $newGroupID
1987    *   FK to civicrm_custom_group.
1988    */
1989   public static function moveField($fieldID, $newGroupID) {
1990     $validation = self::_moveFieldValidate($fieldID, $newGroupID);
1991     if (TRUE !== $validation) {
1992       CRM_Core_Error::fatal(implode(' ', $validation));
1993     }
1994     $field = new CRM_Core_DAO_CustomField();
1995     $field->id = $fieldID;
1996     $field->find(TRUE);
1997
1998     $newGroup = new CRM_Core_DAO_CustomGroup();
1999     $newGroup->id = $newGroupID;
2000     $newGroup->find(TRUE);
2001
2002     $oldGroup = new CRM_Core_DAO_CustomGroup();
2003     $oldGroup->id = $field->custom_group_id;
2004     $oldGroup->find(TRUE);
2005
2006     $add = clone$field;
2007     $add->custom_group_id = $newGroup->id;
2008     self::createField($add, 'add');
2009
2010     $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
2011             SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
2012             ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
2013             ";
2014     CRM_Core_DAO::executeQuery($sql);
2015
2016     $del = clone$field;
2017     $del->custom_group_id = $oldGroup->id;
2018     self::createField($del, 'delete');
2019
2020     $add->save();
2021
2022     CRM_Utils_System::flushCache();
2023   }
2024
2025   /**
2026    * Get the database table name and column name for a custom field.
2027    *
2028    * @param int $fieldID
2029    *   The fieldID of the custom field.
2030    * @param bool $force
2031    *   Force the sql to be run again (primarily used for tests).
2032    *
2033    * @return array
2034    *   fatal is fieldID does not exists, else array of tableName, columnName
2035    */
2036   public static function getTableColumnGroup($fieldID, $force = FALSE) {
2037     $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2038     $cache = CRM_Utils_Cache::singleton();
2039     $fieldValues = $cache->get($cacheKey);
2040     if (empty($fieldValues) || $force) {
2041       $query = "
2042 SELECT cg.table_name, cf.column_name, cg.id
2043 FROM   civicrm_custom_group cg,
2044        civicrm_custom_field cf
2045 WHERE  cf.custom_group_id = cg.id
2046 AND    cf.id = %1";
2047       $params = array(1 => array($fieldID, 'Integer'));
2048       $dao = CRM_Core_DAO::executeQuery($query, $params);
2049
2050       if (!$dao->fetch()) {
2051         CRM_Core_Error::fatal();
2052       }
2053       $dao->free();
2054       $fieldValues = array($dao->table_name, $dao->column_name, $dao->id);
2055       $cache->set($cacheKey, $fieldValues);
2056     }
2057     return $fieldValues;
2058   }
2059
2060   /**
2061    * Get custom option groups.
2062    *
2063    * @deprecated Use the API OptionGroup.get
2064    *
2065    * @param array $includeFieldIds
2066    *   Ids of custom fields for which option groups must be included.
2067    *
2068    * Currently this is required in the cases where option groups are to be included
2069    * for inactive fields : CRM-5369
2070    *
2071    * @return mixed
2072    */
2073   public static function customOptionGroup($includeFieldIds = NULL) {
2074     static $customOptionGroup = NULL;
2075
2076     $cacheKey = (empty($includeFieldIds)) ? 'onlyActive' : 'force';
2077     if ($cacheKey == 'force') {
2078       $customOptionGroup[$cacheKey] = NULL;
2079     }
2080
2081     if (empty($customOptionGroup[$cacheKey])) {
2082       $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2083
2084       //support for single as well as array format.
2085       if (!empty($includeFieldIds)) {
2086         if (is_array($includeFieldIds)) {
2087           $includeFieldIds = implode(',', $includeFieldIds);
2088         }
2089         $whereClause .= "OR f.id IN ( $includeFieldIds )";
2090       }
2091
2092       $query = "
2093     SELECT  g.id, g.title
2094       FROM  civicrm_option_group g
2095 INNER JOIN  civicrm_custom_field f ON ( g.id = f.option_group_id )
2096      WHERE  {$whereClause}";
2097
2098       $dao = CRM_Core_DAO::executeQuery($query);
2099       while ($dao->fetch()) {
2100         $customOptionGroup[$cacheKey][$dao->id] = $dao->title;
2101       }
2102     }
2103
2104     return $customOptionGroup[$cacheKey];
2105   }
2106
2107   /**
2108    * Fix orphan groups.
2109    *
2110    * @param int $customFieldId
2111    *   Custom field id.
2112    * @param int $optionGroupId
2113    *   Option group id.
2114    */
2115   public static function fixOptionGroups($customFieldId, $optionGroupId) {
2116     // check if option group belongs to any custom Field else delete
2117     // get the current option group
2118     $currentOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
2119       $customFieldId,
2120       'option_group_id'
2121     );
2122     // get the updated option group
2123     // if both are same return
2124     if ($currentOptionGroupId == $optionGroupId) {
2125       return;
2126     }
2127
2128     // check if option group is related to any other field
2129     self::checkOptionGroup($currentOptionGroupId);
2130   }
2131
2132   /**
2133    * Check if option group is related to more than one custom field.
2134    *
2135    * @param int $optionGroupId
2136    *   Option group id.
2137    */
2138   public static function checkOptionGroup($optionGroupId) {
2139     $query = "
2140 SELECT count(*)
2141 FROM   civicrm_custom_field
2142 WHERE  option_group_id = {$optionGroupId}";
2143
2144     $count = CRM_Core_DAO::singleValueQuery($query);
2145
2146     if ($count < 2) {
2147       //delete the option group
2148       CRM_Core_BAO_OptionGroup::del($optionGroupId);
2149     }
2150   }
2151
2152   /**
2153    * Get option group default.
2154    *
2155    * @param int $optionGroupId
2156    * @param string $htmlType
2157    *
2158    * @return null|string
2159    */
2160   public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2161     $query = "
2162 SELECT   default_value, html_type
2163 FROM     civicrm_custom_field
2164 WHERE    option_group_id = {$optionGroupId}
2165 AND      default_value IS NOT NULL
2166 ORDER BY html_type";
2167
2168     $dao = CRM_Core_DAO::executeQuery($query);
2169     $defaultValue = NULL;
2170     $defaultHTMLType = NULL;
2171     while ($dao->fetch()) {
2172       if ($dao->html_type == $htmlType) {
2173         return $dao->default_value;
2174       }
2175       if ($defaultValue == NULL) {
2176         $defaultValue = $dao->default_value;
2177         $defaultHTMLType = $dao->html_type;
2178       }
2179     }
2180
2181     // some conversions are needed if either the old or new has a html type which has potential
2182     // multiple default values.
2183     if (($htmlType == 'CheckBox' || $htmlType == 'Multi-Select') &&
2184       ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2185     ) {
2186       $defaultValue = CRM_Core_DAO::VALUE_SEPARATOR . $defaultValue . CRM_Core_DAO::VALUE_SEPARATOR;
2187     }
2188     elseif (($defaultHTMLType == 'CheckBox' || $defaultHTMLType == 'Multi-Select') &&
2189       ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2190     ) {
2191       $defaultValue = substr($defaultValue, 1, -1);
2192       $values = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2193         substr($defaultValue, 1, -1)
2194       );
2195       $defaultValue = $values[0];
2196     }
2197
2198     return $defaultValue;
2199   }
2200
2201   /**
2202    * Post process function.
2203    *
2204    * @param array $params
2205    * @param int $entityID
2206    * @param string $customFieldExtends
2207    * @param bool $inline
2208    * @param bool $checkPermissions
2209    *
2210    * @return array
2211    */
2212   public static function postProcess(
2213     &$params,
2214     $entityID,
2215     $customFieldExtends,
2216     $inline = FALSE,
2217     $checkPermissions = TRUE
2218   ) {
2219     $customData = array();
2220
2221     foreach ($params as $key => $value) {
2222       if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE)) {
2223
2224         // for autocomplete transfer hidden value instead of label
2225         if ($params[$key] && isset($params[$key . '_id'])) {
2226           $value = $params[$key . '_id'];
2227         }
2228
2229         // we need to append time with date
2230         if ($params[$key] && isset($params[$key . '_time'])) {
2231           $value .= ' ' . $params[$key . '_time'];
2232         }
2233
2234         CRM_Core_BAO_CustomField::formatCustomField($customFieldInfo[0],
2235           $customData,
2236           $value,
2237           $customFieldExtends,
2238           $customFieldInfo[1],
2239           $entityID,
2240           $inline,
2241           $checkPermissions
2242         );
2243       }
2244     }
2245     return $customData;
2246   }
2247
2248   /**
2249    * Get custom field ID from field/group name/title.
2250    *
2251    * @param string $fieldName Field name or label
2252    * @param string|null $groupTitle (Optional) Group name or label
2253    * @param bool $fullString Whether to return "custom_123" or "123"
2254    *
2255    * @return string|int|null
2256    * @throws \CiviCRM_API3_Exception
2257    */
2258   public static function getCustomFieldID($fieldName, $groupTitle = NULL, $fullString = FALSE) {
2259     if (!isset(Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName])) {
2260       $customFieldParams = [
2261         'name' => $fieldName,
2262         'label' => $fieldName,
2263         'options' => ['or' => [["name", "label"]]],
2264       ];
2265
2266       if ($groupTitle) {
2267         $customFieldParams['custom_group_id.name'] = $groupTitle;
2268         $customFieldParams['custom_group_id.title'] = $groupTitle;
2269         $customFieldParams['options'] = ['or' => [["name", "label"], ["custom_group_id.name", "custom_group_id.title"]]];
2270       }
2271
2272       $field = civicrm_api3('CustomField', 'get', $customFieldParams);
2273
2274       if (empty($field['id'])) {
2275         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = NULL;
2276         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = NULL;
2277       }
2278       else {
2279         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = $field['id'];
2280         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = 'custom_' . $field['id'];
2281       }
2282     }
2283
2284     if ($fullString) {
2285       return Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'];
2286     }
2287     return Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'];
2288   }
2289
2290   /**
2291    * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2292    *
2293    * @param array $ids
2294    *
2295    * @return array
2296    */
2297   public static function getNameFromID($ids) {
2298     if (is_array($ids)) {
2299       $ids = implode(',', $ids);
2300     }
2301     $sql = "
2302 SELECT     f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2303 FROM       civicrm_custom_field f
2304 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2305 WHERE      f.id IN ($ids)";
2306
2307     $dao = CRM_Core_DAO::executeQuery($sql);
2308     $result = array();
2309     while ($dao->fetch()) {
2310       $result[$dao->id] = array(
2311         'field_name' => $dao->field_name,
2312         'field_label' => $dao->field_label,
2313         'group_name' => $dao->group_name,
2314         'group_title' => $dao->group_title,
2315       );
2316     }
2317     return $result;
2318   }
2319
2320   /**
2321    * Validate custom data.
2322    *
2323    * @param array $params
2324    *   Custom data submitted.
2325    *   ie array( 'custom_1' => 'validate me' );
2326    *
2327    * @return array
2328    *   validation errors.
2329    */
2330   public static function validateCustomData($params) {
2331     $errors = array();
2332     if (!is_array($params) || empty($params)) {
2333       return $errors;
2334     }
2335
2336     //pick up profile fields.
2337     $profileFields = array();
2338     $ufGroupId = CRM_Utils_Array::value('ufGroupId', $params);
2339     if ($ufGroupId) {
2340       $profileFields = CRM_Core_BAO_UFGroup::getFields($ufGroupId,
2341         FALSE,
2342         CRM_Core_Action::VIEW
2343       );
2344     }
2345
2346     //lets start w/ params.
2347     foreach ($params as $key => $value) {
2348       $customFieldID = self::getKeyID($key);
2349       if (!$customFieldID) {
2350         continue;
2351       }
2352
2353       //load the structural info for given field.
2354       $field = new CRM_Core_DAO_CustomField();
2355       $field->id = $customFieldID;
2356       if (!$field->find(TRUE)) {
2357         continue;
2358       }
2359       $dataType = $field->data_type;
2360
2361       $profileField = CRM_Utils_Array::value($key, $profileFields, array());
2362       $fieldTitle = CRM_Utils_Array::value('title', $profileField);
2363       $isRequired = CRM_Utils_Array::value('is_required', $profileField);
2364       if (!$fieldTitle) {
2365         $fieldTitle = $field->label;
2366       }
2367
2368       //no need to validate.
2369       if (CRM_Utils_System::isNull($value) && !$isRequired) {
2370         continue;
2371       }
2372
2373       //lets validate first for required field.
2374       if ($isRequired && CRM_Utils_System::isNull($value)) {
2375         $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2376         continue;
2377       }
2378
2379       //now time to take care of custom field form rules.
2380       $ruleName = $errorMsg = NULL;
2381       switch ($dataType) {
2382         case 'Int':
2383           $ruleName = 'integer';
2384           $errorMsg = ts('%1 must be an integer (whole number).',
2385             array(1 => $fieldTitle)
2386           );
2387           break;
2388
2389         case 'Money':
2390           $ruleName = 'money';
2391           $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2392             array(1 => $fieldTitle)
2393           );
2394           break;
2395
2396         case 'Float':
2397           $ruleName = 'numeric';
2398           $errorMsg = ts('%1 must be a number (with or without decimal point).',
2399             array(1 => $fieldTitle)
2400           );
2401           break;
2402
2403         case 'Link':
2404           $ruleName = 'wikiURL';
2405           $errorMsg = ts('%1 must be valid Website.',
2406             array(1 => $fieldTitle)
2407           );
2408           break;
2409       }
2410
2411       if ($ruleName && !CRM_Utils_System::isNull($value)) {
2412         $valid = FALSE;
2413         $funName = "CRM_Utils_Rule::{$ruleName}";
2414         if (is_callable($funName)) {
2415           $valid = call_user_func($funName, $value);
2416         }
2417         if (!$valid) {
2418           $errors[$key] = $errorMsg;
2419         }
2420       }
2421     }
2422
2423     return $errors;
2424   }
2425
2426   /**
2427    * Is this field a multi record field.
2428    *
2429    * @param int $customId
2430    *
2431    * @return bool
2432    */
2433   public static function isMultiRecordField($customId) {
2434     $isMultipleWithGid = FALSE;
2435     if (!is_numeric($customId)) {
2436       $customId = self::getKeyID($customId);
2437     }
2438     if (is_numeric($customId)) {
2439       $sql = "SELECT cg.id cgId
2440  FROM civicrm_custom_group cg
2441  INNER JOIN civicrm_custom_field cf
2442  ON cg.id = cf.custom_group_id
2443 WHERE cf.id = %1 AND cg.is_multiple = 1";
2444       $params[1] = array($customId, 'Integer');
2445       $dao = CRM_Core_DAO::executeQuery($sql, $params);
2446       if ($dao->fetch()) {
2447         if ($dao->cgId) {
2448           $isMultipleWithGid = $dao->cgId;
2449         }
2450       }
2451     }
2452
2453     return $isMultipleWithGid;
2454   }
2455
2456   /**
2457    * Does this field type have any select options?
2458    *
2459    * @param array $field
2460    *
2461    * @return bool
2462    */
2463   public static function hasOptions($field) {
2464     // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2465     $field = (array) $field;
2466     // This will include boolean fields with Yes/No options.
2467     if (in_array($field['html_type'], ['Radio', 'CheckBox'])) {
2468       return TRUE;
2469     }
2470     // Do this before the "Select" string search because date fields have a "Select Date" html_type
2471     // and contactRef fields have an "Autocomplete-Select" html_type - contacts are an FK not an option list.
2472     if (in_array($field['data_type'], ['ContactReference', 'Date'])) {
2473       return FALSE;
2474     }
2475     if (strpos($field['html_type'], 'Select') !== FALSE) {
2476       return TRUE;
2477     }
2478     return !empty($field['option_group_id']);
2479   }
2480
2481   /**
2482    * Does this field store a serialized string?
2483    *
2484    * @param array $field
2485    *
2486    * @return bool
2487    */
2488   public static function isSerialized($field) {
2489     // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2490     $field = (array) $field;
2491     // FIXME: Currently the only way to know if data is serialized is by looking at the html_type. It would be cleaner to decouple this.
2492     return ($field['html_type'] == 'CheckBox' || strpos($field['html_type'], 'Multi') !== FALSE);
2493   }
2494
2495   /**
2496    * Get api entity for this field
2497    *
2498    * @return string
2499    */
2500   public function getEntity() {
2501     $entity = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->custom_group_id, 'extends');
2502     return in_array($entity, array('Individual', 'Household', 'Organization')) ? 'Contact' : $entity;
2503   }
2504
2505   /**
2506    * Set pseudoconstant properties for field metadata.
2507    *
2508    * @param array $field
2509    * @param string|null $optionGroupName
2510    */
2511   private static function getOptionsForField(&$field, $optionGroupName) {
2512     if ($optionGroupName) {
2513       $field['pseudoconstant'] = array(
2514         'optionGroupName' => $optionGroupName,
2515         'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2516       );
2517     }
2518     elseif ($field['data_type'] == 'Boolean') {
2519       $field['pseudoconstant'] = array(
2520         'callback' => 'CRM_Core_SelectValues::boolean',
2521       );
2522     }
2523     elseif ($field['data_type'] == 'Country') {
2524       $field['pseudoconstant'] = array(
2525         'table' => 'civicrm_country',
2526         'keyColumn' => 'id',
2527         'labelColumn' => 'name',
2528         'nameColumn' => 'iso_code',
2529       );
2530     }
2531     elseif ($field['data_type'] == 'StateProvince') {
2532       $field['pseudoconstant'] = array(
2533         'table' => 'civicrm_state_province',
2534         'keyColumn' => 'id',
2535         'labelColumn' => 'name',
2536       );
2537     }
2538   }
2539
2540 }