CRM/Core/BAO/CustomField.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 5                                                  |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  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     if (!isset($label)) {
 885       $label = $field->label;
 886     }
 887
 888     // at some point in time we might want to split the below into small functions
 889
 890     switch ($widget) {
 891       case 'Text':
 892       case 'Link':
 893         if ($field->is_search_range && $search) {
 894           $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
 895           $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
 896         }
 897         else {
 898           if ($field->text_length) {
 899             $field->attributes .= ' maxlength=' . $field->text_length;
 900             if ($field->text_length < 20) {
 901               $field->attributes .= ' size=' . $field->text_length;
 902             }
 903           }
 904           $element = $qf->add('text', $elementName, $label,
 905             $field->attributes,
 906             $useRequired && !$search
 907           );
 908         }
 909         break;
 910
 911       case 'TextArea':
 912         $attributes = $dataCrmCustomAttr;
 913         if ($field->note_rows) {
 914           $attributes .= 'rows=' . $field->note_rows;
 915         }
 916         else {
 917           $attributes .= 'rows=4';
 918         }
 919         if ($field->note_columns) {
 920           $attributes .= ' cols=' . $field->note_columns;
 921         }
 922         else {
 923           $attributes .= ' cols=60';
 924         }
 925         if ($field->text_length) {
 926           $attributes .= ' maxlength=' . $field->text_length;
 927         }
 928         $element = $qf->add('textarea',
 929           $elementName,
 930           $label,
 931           $attributes,
 932           $useRequired && !$search
 933         );
 934         break;
 935
 936       case 'Select Date':
 937         $attr = array('data-crm-custom' => $dataCrmCustomVal);
 938         //CRM-18379: Fix for date range of 'Select Date' custom field when include in profile.
 939         $minYear = isset($field->start_date_years) ? (date('Y') - $field->start_date_years) : NULL;
 940         $maxYear = isset($field->end_date_years) ? (date('Y') + $field->end_date_years) : NULL;
 941
 942         $params = array(
 943           'date' => $field->date_format,
 944           'minDate' => isset($minYear) ? $minYear . '-01-01' : NULL,
 945           //CRM-18487 - max date should be the last date of the year.
 946           'maxDate' => isset($maxYear) ? $maxYear . '-12-31' : NULL,
 947           'time' => $field->time_format ? $field->time_format * 12 : FALSE,
 948         );
 949         if ($field->is_search_range && $search) {
 950           $qf->add('datepicker', $elementName . '_from', $label, $attr + array('placeholder' => ts('From')), FALSE, $params);
 951           $qf->add('datepicker', $elementName . '_to', NULL, $attr + array('placeholder' => ts('To')), FALSE, $params);
 952         }
 953         else {
 954           $element = $qf->add('datepicker', $elementName, $label, $attr, $useRequired && !$search, $params);
 955         }
 956         break;
 957
 958       case 'Radio':
 959         $choice = array();
 960         parse_str($field->attributes, $radioAttributes);
 961         $radioAttributes = array_merge($radioAttributes, $customFieldAttributes);
 962
 963         foreach ($options as $v => $l) {
 964           $choice[] = $qf->createElement('radio', NULL, '', $l, (string) $v, $radioAttributes);
 965         }
 966         $element = $qf->addGroup($choice, $elementName, $label);
 967         $optionEditKey = 'data-option-edit-path';
 968         if (isset($selectAttributes[$optionEditKey])) {
 969           $element->setAttribute($optionEditKey, $selectAttributes[$optionEditKey]);
 970         }
 971
 972         if ($useRequired && !$search) {
 973           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
 974         }
 975         else {
 976           $element->setAttribute('allowClear', TRUE);
 977         }
 978         break;
 979
 980       // For all select elements
 981       case 'Select':
 982         if (empty($selectAttributes['multiple'])) {
 983           $options = array('' => $placeholder) + $options;
 984         }
 985         $element = $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $selectAttributes);
 986
 987         // Add and/or option for fields that store multiple values
 988         if ($search && self::isSerialized($field)) {
 989
 990           $operators = array(
 991             $qf->createElement('radio', NULL, '', ts('Any'), 'or', array('title' => ts('Results may contain any of the selected options'))),
 992             $qf->createElement('radio', NULL, '', ts('All'), 'and', array('title' => ts('Results must have all of the selected options'))),
 993           );
 994           $qf->addGroup($operators, $elementName . '_operator');
 995           $qf->setDefaults(array($elementName . '_operator' => 'or'));
 996         }
 997         break;
 998
 999       case 'CheckBox':
1000         $check = array();
1001         foreach ($options as $v => $l) {
1002           $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, $customFieldAttributes);
1003         }
1004
1005         $group = $element = $qf->addGroup($check, $elementName, $label);
1006         $optionEditKey = 'data-option-edit-path';
1007         if (isset($customFieldAttributes[$optionEditKey])) {
1008           $group->setAttribute($optionEditKey, $customFieldAttributes[$optionEditKey]);
1009         }
1010
1011         if ($useRequired && !$search) {
1012           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
1013         }
1014         break;
1015
1016       case 'File':
1017         // we should not build upload file in search mode
1018         if ($search) {
1019           return NULL;
1020         }
1021         $element = $qf->add(
1022           strtolower($field->html_type),
1023           $elementName,
1024           $label,
1025           $field->attributes,
1026           $useRequired && !$search
1027         );
1028         $qf->addUploadElement($elementName);
1029         break;
1030
1031       case 'RichTextEditor':
1032         $attributes = array(
1033           'rows' => $field->note_rows,
1034           'cols' => $field->note_columns,
1035           'data-crm-custom' => $dataCrmCustomVal,
1036         );
1037         if ($field->text_length) {
1038           $attributes['maxlength'] = $field->text_length;
1039         }
1040         $element = $qf->add('wysiwyg', $elementName, $label, $attributes, $useRequired && !$search);
1041         break;
1042
1043       case 'Autocomplete-Select':
1044         static $customUrls = array();
1045         // Fixme: why is this a string in the first place??
1046         $attributes = array();
1047         if ($field->attributes) {
1048           foreach (explode(' ', $field->attributes) as $at) {
1049             if (strpos($at, '=')) {
1050               list($k, $v) = explode('=', $at);
1051               $attributes[$k] = trim($v, ' "');
1052             }
1053           }
1054         }
1055         if ($field->data_type == 'ContactReference') {
1056           // break if contact does not have permission to access ContactReference
1057           if (!CRM_Core_Permission::check('access contact reference fields')) {
1058             break;
1059           }
1060           $attributes['class'] = (isset($attributes['class']) ? $attributes['class'] . ' ' : '') . 'crm-form-contact-reference huge';
1061           $attributes['data-api-entity'] = 'Contact';
1062           $element = $qf->add('text', $elementName, $label, $attributes, $useRequired && !$search);
1063
1064           $urlParams = "context=customfield&id={$field->id}";
1065           $idOfelement = $elementName;
1066           // dev/core#362 if in an onbehalf profile clean up the name to get rid of square brackets that break the select 2 js
1067           if (strpos($elementName, '[') && strpos($elementName, ']')) {
1068             $idOfelement = substr(substr($elementName, (strpos($elementName, '[') + 1)), 0, -1);
1069           }
1070           $customUrls[$idOfelement] = CRM_Utils_System::url('civicrm/ajax/contactref',
1071             $urlParams,
1072             FALSE, NULL, FALSE
1073           );
1074
1075         }
1076         else {
1077           // FIXME: This won't work with customFieldOptions hook
1078           $attributes += array(
1079             'entity' => 'option_value',
1080             'placeholder' => $placeholder,
1081             'multiple' => $search,
1082             'api' => array(
1083               'params' => array('option_group_id' => $field->option_group_id),
1084             ),
1085           );
1086           $element = $qf->addEntityRef($elementName, $label, $attributes, $useRequired && !$search);
1087         }
1088
1089         $qf->assign('customUrls', $customUrls);
1090         break;
1091     }
1092
1093     switch ($field->data_type) {
1094       case 'Int':
1095         // integers will have numeric rule applied to them.
1096         if ($field->is_search_range && $search) {
1097           $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1098           $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1099         }
1100         elseif ($widget == 'Text') {
1101           $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1102         }
1103         break;
1104
1105       case 'Float':
1106         if ($field->is_search_range && $search) {
1107           $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1108           $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1109         }
1110         elseif ($widget == 'Text') {
1111           $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1112         }
1113         break;
1114
1115       case 'Money':
1116         if ($field->is_search_range && $search) {
1117           $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1118           $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1119         }
1120         elseif ($widget == 'Text') {
1121           $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1122         }
1123         break;
1124
1125       case 'Link':
1126         $element->setAttribute('class', "url");
1127         $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
1128         break;
1129     }
1130     if ($field->is_view && !$search) {
1131       $qf->freeze($elementName);
1132     }
1133     return $element;
1134   }
1135
1136   /**
1137    * Delete the Custom Field.
1138    *
1139    * @param object $field
1140    *   The field object.
1141    */
1142   public static function deleteField($field) {
1143     CRM_Utils_System::flushCache();
1144
1145     // first delete the custom option group and values associated with this field
1146     if ($field->option_group_id) {
1147       //check if option group is related to any other field, if
1148       //not delete the option group and related option values
1149       self::checkOptionGroup($field->option_group_id);
1150     }
1151
1152     // next drop the column from the custom value table
1153     self::createField($field, 'delete');
1154
1155     $field->delete();
1156     CRM_Core_BAO_UFField::delUFField($field->id);
1157     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1158
1159     CRM_Utils_Hook::post('delete', 'CustomField', $field->id, $field);
1160   }
1161
1162   /**
1163    * @param string|int|array|null $value
1164    * @param CRM_Core_BAO_CustomField|int|array|string $field
1165    * @param int $entityId
1166    *
1167    * @return string
1168    * @throws \Exception
1169    */
1170   public static function displayValue($value, $field, $entityId = NULL) {
1171     $field = is_array($field) ? $field['id'] : $field;
1172     $fieldId = is_object($field) ? $field->id : (int) str_replace('custom_', '', $field);
1173
1174     if (!$fieldId) {
1175       throw new Exception('CRM_Core_BAO_CustomField::displayValue requires a field id');
1176     }
1177
1178     if (!is_a($field, 'CRM_Core_BAO_CustomField')) {
1179       $field = self::getFieldObject($fieldId);
1180     }
1181
1182     $fieldInfo = array('options' => $field->getOptions()) + (array) $field;
1183
1184     return self::formatDisplayValue($value, $fieldInfo, $entityId);
1185   }
1186
1187   /**
1188    * Lower-level logic for rendering a custom field value
1189    *
1190    * @param string|array $value
1191    * @param array $field
1192    * @param int|null $entityId
1193    *
1194    * @return string
1195    */
1196   private static function formatDisplayValue($value, $field, $entityId = NULL) {
1197
1198     if (self::isSerialized($field) && !is_array($value)) {
1199       $value = CRM_Utils_Array::explodePadded($value);
1200     }
1201     // CRM-12989 fix
1202     if ($field['html_type'] == 'CheckBox') {
1203       CRM_Utils_Array::formatArrayKeys($value);
1204     }
1205
1206     $display = is_array($value) ? implode(', ', $value) : (string) $value;
1207
1208     switch ($field['html_type']) {
1209
1210       case 'Select':
1211       case 'Autocomplete-Select':
1212       case 'Radio':
1213       case 'Select Country':
1214       case 'Select State/Province':
1215       case 'CheckBox':
1216       case 'Multi-Select':
1217       case 'Multi-Select State/Province':
1218       case 'Multi-Select Country':
1219         if ($field['data_type'] == 'ContactReference' && $value) {
1220           $display = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1221         }
1222         elseif (is_array($value)) {
1223           $v = array();
1224           foreach ($value as $key => $val) {
1225             $v[] = CRM_Utils_Array::value($val, $field['options']);
1226           }
1227           $display = implode(', ', $v);
1228         }
1229         else {
1230           $display = CRM_Utils_Array::value($value, $field['options'], '');
1231         }
1232         break;
1233
1234       case 'Select Date':
1235         $customFormat = NULL;
1236
1237         // FIXME: Are there any legitimate reasons why $value would be an array?
1238         // Or should we throw an exception here if it is?
1239         $value = is_array($value) ? CRM_Utils_Array::first($value) : $value;
1240
1241         $actualPHPFormats = CRM_Utils_Date::datePluginToPHPFormats();
1242         $format = CRM_Utils_Array::value('date_format', $field);
1243
1244         if ($format) {
1245           if (array_key_exists($format, $actualPHPFormats)) {
1246             $customTimeFormat = (array) $actualPHPFormats[$format];
1247             switch (CRM_Utils_Array::value('time_format', $field)) {
1248               case 1:
1249                 $customTimeFormat[] = 'g:iA';
1250                 break;
1251
1252               case 2:
1253                 $customTimeFormat[] = 'G:i';
1254                 break;
1255
1256               default:
1257                 //If time is not selected remove time from value.
1258                 $value = $value ? date('Y-m-d', strtotime($value)) : '';
1259             }
1260             $customFormat = implode(" ", $customTimeFormat);
1261           }
1262         }
1263         $display = CRM_Utils_Date::processDate($value, NULL, FALSE, $customFormat);
1264         break;
1265
1266       case 'File':
1267         // In the context of displaying a profile, show file/image
1268         if ($value) {
1269           if ($entityId) {
1270             if (CRM_Utils_Rule::positiveInteger($value)) {
1271               $fileId = $value;
1272             }
1273             else {
1274               $fileId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File', $value, 'id', 'uri');
1275             }
1276             $url = self::getFileURL($entityId, $field['id'], $fileId);
1277             if ($url) {
1278               $display = $url['file_url'];
1279             }
1280           }
1281           else {
1282             // In other contexts show a paperclip icon
1283             if (CRM_Utils_Rule::integer($value)) {
1284               $icons = CRM_Core_BAO_File::paperIconAttachment('*', $value);
1285               $display = $icons[$value];
1286             }
1287             else {
1288               //CRM-18396, if filename is passed instead
1289               $display = $value;
1290             }
1291           }
1292         }
1293         break;
1294
1295       case 'Link':
1296         $display = $display ? "<a href=\"$display\" target=\"_blank\">$display</a>" : $display;
1297         break;
1298
1299       case 'TextArea':
1300         $display = nl2br($display);
1301         break;
1302
1303       case 'Text':
1304         if ($field['data_type'] == 'Money' && isset($value)) {
1305           //$value can also be an array(while using IN operator from search builder or api).
1306           foreach ((array) $value as $val) {
1307             $disp[] = CRM_Utils_Money::format($val, NULL, NULL, TRUE);
1308           }
1309           $display = implode(', ', $disp);
1310         }
1311         break;
1312     }
1313     return $display;
1314   }
1315
1316   /**
1317    * Set default values for custom data used in profile.
1318    *
1319    * @param int $customFieldId
1320    *   Custom field id.
1321    * @param string $elementName
1322    *   Custom field name.
1323    * @param array $defaults
1324    *   Associated array of fields.
1325    * @param int $contactId
1326    *   Contact id.
1327    * @param int $mode
1328    *   Profile mode.
1329    * @param mixed $value
1330    *   If passed - dont fetch value from db,.
1331    *                               just format the given value
1332    */
1333   public static function setProfileDefaults(
1334     $customFieldId,
1335     $elementName,
1336     &$defaults,
1337     $contactId = NULL,
1338     $mode = NULL,
1339     $value = NULL
1340   ) {
1341     //get the type of custom field
1342     $customField = new CRM_Core_BAO_CustomField();
1343     $customField->id = $customFieldId;
1344     $customField->find(TRUE);
1345
1346     if (!$contactId) {
1347       if ($mode == CRM_Profile_Form::MODE_CREATE) {
1348         $value = $customField->default_value;
1349       }
1350     }
1351     else {
1352       if (!isset($value)) {
1353         $info = self::getTableColumnGroup($customFieldId);
1354         $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1355         $result = CRM_Core_DAO::executeQuery($query);
1356         if ($result->fetch()) {
1357           $value = $result->value;
1358         }
1359       }
1360
1361       if ($customField->data_type == 'Country') {
1362         if (!$value) {
1363           $config = CRM_Core_Config::singleton();
1364           if ($config->defaultContactCountry) {
1365             $value = $config->defaultContactCountry();
1366           }
1367         }
1368       }
1369     }
1370
1371     //set defaults if mode is registration
1372     if (!trim($value) &&
1373       ($value !== 0) &&
1374       (!in_array($mode, array(CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)))
1375     ) {
1376       $value = $customField->default_value;
1377     }
1378
1379     if ($customField->data_type == 'Money' && isset($value)) {
1380       $value = number_format($value, 2);
1381     }
1382     switch ($customField->html_type) {
1383       case 'CheckBox':
1384       case 'Multi-Select':
1385         $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldId, FALSE);
1386         $defaults[$elementName] = array();
1387         $checkedValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1388           substr($value, 1, -1)
1389         );
1390         foreach ($customOption as $val) {
1391           if (in_array($val['value'], $checkedValue)) {
1392             if ($customField->html_type == 'CheckBox') {
1393               $defaults[$elementName][$val['value']] = 1;
1394             }
1395             elseif ($customField->html_type == 'Multi-Select') {
1396               $defaults[$elementName][$val['value']] = $val['value'];
1397             }
1398           }
1399         }
1400         break;
1401
1402       case 'Autocomplete-Select':
1403         if ($customField->data_type == 'ContactReference') {
1404           if (is_numeric($value)) {
1405             $defaults[$elementName . '_id'] = $value;
1406             $defaults[$elementName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1407           }
1408         }
1409         else {
1410           $defaults[$elementName] = $value;
1411         }
1412         break;
1413
1414       default:
1415         $defaults[$elementName] = $value;
1416     }
1417   }
1418
1419   /**
1420    * Get file url.
1421    *
1422    * @param int $contactID
1423    * @param int $cfID
1424    * @param int $fileID
1425    * @param bool $absolute
1426    *
1427    * @param string $multiRecordWhereClause
1428    *
1429    * @return array
1430    */
1431   public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1432     if ($contactID) {
1433       if (!$fileID) {
1434         $params = array('id' => $cfID);
1435         $defaults = array();
1436         CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1437         $columnName = $defaults['column_name'];
1438
1439         //table name of custom data
1440         $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
1441           $defaults['custom_group_id'],
1442           'table_name', 'id'
1443         );
1444
1445         //query to fetch id from civicrm_file
1446         if ($multiRecordWhereClause) {
1447           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1448         }
1449         else {
1450           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1451         }
1452         $fileID = CRM_Core_DAO::singleValueQuery($query);
1453       }
1454
1455       $result = array();
1456       if ($fileID) {
1457         $fileType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1458           $fileID,
1459           'mime_type',
1460           'id'
1461         );
1462         $result['file_id'] = $fileID;
1463
1464         if ($fileType == 'image/jpeg' ||
1465           $fileType == 'image/pjpeg' ||
1466           $fileType == 'image/gif' ||
1467           $fileType == 'image/x-png' ||
1468           $fileType == 'image/png'
1469         ) {
1470           $entityId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile',
1471             $fileID,
1472             'entity_id',
1473             'file_id'
1474           );
1475           list($path) = CRM_Core_BAO_File::path($fileID, $entityId, NULL, NULL);
1476           $url = CRM_Utils_System::url('civicrm/file',
1477             "reset=1&id=$fileID&eid=$contactID",
1478             $absolute, NULL, TRUE, TRUE
1479           );
1480           $result['file_url'] = CRM_Utils_File::getFileURL($path, $fileType, $url);
1481         }
1482         // for non image files
1483         else {
1484           $uri = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1485             $fileID,
1486             'uri'
1487           );
1488           $url = CRM_Utils_System::url('civicrm/file',
1489             "reset=1&id=$fileID&eid=$contactID",
1490             $absolute, NULL, TRUE, TRUE
1491           );
1492           $result['file_url'] = CRM_Utils_File::getFileURL($uri, $fileType, $url);
1493         }
1494       }
1495       return $result;
1496     }
1497   }
1498
1499   /**
1500    * Format custom fields before inserting.
1501    *
1502    * @param int $customFieldId
1503    *   Custom field id.
1504    * @param array $customFormatted
1505    *   Formatted array.
1506    * @param mixed $value
1507    *   Value of custom field.
1508    * @param string $customFieldExtend
1509    *   Custom field extends.
1510    * @param int $customValueId
1511    *   Custom option value id.
1512    * @param int $entityId
1513    *   Entity id (contribution, membership...).
1514    * @param bool $inline
1515    *   Consider inline custom groups only.
1516    * @param bool $checkPermission
1517    *   If false, do not include permissioning clause.
1518    * @param bool $includeViewOnly
1519    *   If true, fields marked 'View Only' are included. Required for APIv3.
1520    *
1521    * @return array|NULL
1522    *   formatted custom field array
1523    */
1524   public static function formatCustomField(
1525     $customFieldId, &$customFormatted, $value,
1526     $customFieldExtend, $customValueId = NULL,
1527     $entityId = NULL,
1528     $inline = FALSE,
1529     $checkPermission = TRUE,
1530     $includeViewOnly = FALSE
1531   ) {
1532     //get the custom fields for the entity
1533     //subtype and basic type
1534     $customDataSubType = NULL;
1535     if ($customFieldExtend) {
1536       // This is the case when getFieldsForImport() requires fields
1537       // of subtype and its parent.CRM-5143
1538       // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1539       $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType::subTypes(), (array) $customFieldExtend);
1540       if (!empty($customDataSubType) && is_array($customDataSubType)) {
1541         $customFieldExtend = CRM_Contact_BAO_ContactType::getBasicType($customDataSubType);
1542         if (is_array($customFieldExtend)) {
1543           $customFieldExtend = array_unique(array_values($customFieldExtend));
1544         }
1545       }
1546     }
1547
1548     $customFields = CRM_Core_BAO_CustomField::getFields($customFieldExtend,
1549       FALSE,
1550       $inline,
1551       $customDataSubType,
1552       NULL,
1553       FALSE,
1554       FALSE,
1555       $checkPermission
1556     );
1557
1558     if (!array_key_exists($customFieldId, $customFields)) {
1559       return NULL;
1560     }
1561
1562     // return if field is a 'code' field
1563     if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1564       return NULL;
1565     }
1566
1567     list($tableName, $columnName, $groupID) = self::getTableColumnGroup($customFieldId);
1568
1569     if (!$customValueId &&
1570       // we always create new entites for is_multiple unless specified
1571       !$customFields[$customFieldId]['is_multiple'] &&
1572       $entityId
1573     ) {
1574       $query = "
1575 SELECT id
1576   FROM $tableName
1577  WHERE entity_id={$entityId}";
1578
1579       $customValueId = CRM_Core_DAO::singleValueQuery($query);
1580     }
1581
1582     //fix checkbox, now check box always submits values
1583     if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1584       if ($value) {
1585         // Note that only during merge this is not an array, and you can directly use value
1586         if (is_array($value)) {
1587           $selectedValues = array();
1588           foreach ($value as $selId => $val) {
1589             if ($val) {
1590               $selectedValues[] = $selId;
1591             }
1592           }
1593           if (!empty($selectedValues)) {
1594             $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1595                 $selectedValues
1596               ) . CRM_Core_DAO::VALUE_SEPARATOR;
1597           }
1598           else {
1599             $value = '';
1600           }
1601         }
1602       }
1603     }
1604
1605     if ($customFields[$customFieldId]['html_type'] == 'Multi-Select') {
1606       if ($value) {
1607         $value = CRM_Utils_Array::implodePadded($value);
1608       }
1609       else {
1610         $value = '';
1611       }
1612     }
1613
1614     if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1615         $customFields[$customFieldId]['html_type'] == 'CheckBox'
1616       ) &&
1617       $customFields[$customFieldId]['data_type'] == 'String' &&
1618       !empty($customFields[$customFieldId]['text_length']) &&
1619       !empty($value)
1620     ) {
1621       // lets make sure that value is less than the length, else we'll
1622       // be losing some data, CRM-7481
1623       if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1624         // need to do a few things here
1625
1626         // 1. lets find a new length
1627         $newLength = $customFields[$customFieldId]['text_length'];
1628         $minLength = strlen($value);
1629         while ($newLength < $minLength) {
1630           $newLength = $newLength * 2;
1631         }
1632
1633         // set the custom field meta data to have a length larger than value
1634         // alter the custom value table column to match this length
1635         CRM_Core_BAO_SchemaHandler::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1636       }
1637     }
1638
1639     $date = NULL;
1640     if ($customFields[$customFieldId]['data_type'] == 'Date') {
1641       if (!CRM_Utils_System::isNull($value)) {
1642         $format = $customFields[$customFieldId]['date_format'];
1643         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, 'YmdHis', $format);
1644       }
1645       $value = $date;
1646     }
1647
1648     if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1649       $customFields[$customFieldId]['data_type'] == 'Money'
1650     ) {
1651       if (!$value) {
1652         $value = 0;
1653       }
1654
1655       if ($customFields[$customFieldId]['data_type'] == 'Money') {
1656         $value = CRM_Utils_Rule::cleanMoney($value);
1657       }
1658     }
1659
1660     if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1661         $customFields[$customFieldId]['data_type'] == 'Country'
1662       ) &&
1663       empty($value)
1664     ) {
1665       // CRM-3415
1666       $value = 0;
1667     }
1668
1669     $fileId = NULL;
1670
1671     if ($customFields[$customFieldId]['data_type'] == 'File') {
1672       if (empty($value)) {
1673         return;
1674       }
1675
1676       $config = CRM_Core_Config::singleton();
1677
1678       // If we are already passing the file id as a value then retrieve and set the file data
1679       if (CRM_Utils_Rule::integer($value)) {
1680         $fileDAO = new CRM_Core_DAO_File();
1681         $fileDAO->id = $value;
1682         $fileDAO->find(TRUE);
1683         if ($fileDAO->N) {
1684           $fileID = $value;
1685           $fName = $fileDAO->uri;
1686           $mimeType = $fileDAO->mime_type;
1687         }
1688       }
1689       else {
1690         $fName = $value['name'];
1691         $mimeType = $value['type'];
1692       }
1693
1694       $filename = pathinfo($fName, PATHINFO_BASENAME);
1695
1696       // rename this file to go into the secure directory only if
1697       // user has uploaded new file not existing verfied on the basis of $fileID
1698       if (empty($fileID) && !rename($fName, $config->customFileUploadDir . $filename)) {
1699         CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory'));
1700       }
1701
1702       if ($customValueId && empty($fileID)) {
1703         $query = "
1704 SELECT $columnName
1705   FROM $tableName
1706  WHERE id = %1";
1707         $params = array(1 => array($customValueId, 'Integer'));
1708         $fileId = CRM_Core_DAO::singleValueQuery($query, $params);
1709       }
1710
1711       $fileDAO = new CRM_Core_DAO_File();
1712
1713       if ($fileId) {
1714         $fileDAO->id = $fileId;
1715       }
1716
1717       $fileDAO->uri = $filename;
1718       $fileDAO->mime_type = $mimeType;
1719       $fileDAO->upload_date = date('YmdHis');
1720       $fileDAO->save();
1721       $fileId = $fileDAO->id;
1722       $value = $filename;
1723     }
1724
1725     if (!is_array($customFormatted)) {
1726       $customFormatted = array();
1727     }
1728
1729     if (!array_key_exists($customFieldId, $customFormatted)) {
1730       $customFormatted[$customFieldId] = array();
1731     }
1732
1733     $index = -1;
1734     if ($customValueId) {
1735       $index = $customValueId;
1736     }
1737
1738     if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1739       $customFormatted[$customFieldId][$index] = array();
1740     }
1741     $customFormatted[$customFieldId][$index] = array(
1742       'id' => $customValueId > 0 ? $customValueId : NULL,
1743       'value' => $value,
1744       'type' => $customFields[$customFieldId]['data_type'],
1745       'custom_field_id' => $customFieldId,
1746       'custom_group_id' => $groupID,
1747       'table_name' => $tableName,
1748       'column_name' => $columnName,
1749       'file_id' => $fileId,
1750       'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1751     );
1752
1753     //we need to sort so that custom fields are created in the order of entry
1754     krsort($customFormatted[$customFieldId]);
1755     return $customFormatted;
1756   }
1757
1758   /**
1759    * Get default custom table schema.
1760    *
1761    * @param array $params
1762    *
1763    * @return array
1764    */
1765   public static function defaultCustomTableSchema($params) {
1766     // add the id and extends_id
1767     $table = array(
1768       'name' => $params['name'],
1769       'is_multiple' => $params['is_multiple'],
1770       'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1771       'fields' => array(
1772         array(
1773           'name' => 'id',
1774           'type' => 'int unsigned',
1775           'primary' => TRUE,
1776           'required' => TRUE,
1777           'attributes' => 'AUTO_INCREMENT',
1778           'comment' => 'Default MySQL primary key',
1779         ),
1780         array(
1781           'name' => 'entity_id',
1782           'type' => 'int unsigned',
1783           'required' => TRUE,
1784           'comment' => 'Table that this extends',
1785           'fk_table_name' => $params['extends_name'],
1786           'fk_field_name' => 'id',
1787           'fk_attributes' => 'ON DELETE CASCADE',
1788         ),
1789       ),
1790     );
1791
1792     if (!$params['is_multiple']) {
1793       $table['indexes'] = array(
1794         array(
1795           'unique' => TRUE,
1796           'field_name_1' => 'entity_id',
1797         ),
1798       );
1799     }
1800     return $table;
1801   }
1802
1803   /**
1804    * Create custom field.
1805    *
1806    * @param CRM_Core_DAO_CustomField $field
1807    * @param string $operation
1808    * @param bool $indexExist
1809    * @param bool $triggerRebuild
1810    */
1811   public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1812     $tableName = CRM_Core_DAO::getFieldValue(
1813       'CRM_Core_DAO_CustomGroup',
1814       $field->custom_group_id,
1815       'table_name'
1816     );
1817
1818     $params = array(
1819       'table_name' => $tableName,
1820       'operation' => $operation,
1821       'name' => $field->column_name,
1822       'type' => CRM_Core_BAO_CustomValueTable::fieldToSQLType(
1823         $field->data_type,
1824         $field->text_length
1825       ),
1826       'required' => $field->is_required,
1827       'searchable' => $field->is_searchable,
1828     );
1829
1830     if ($operation == 'delete') {
1831       $fkName = "{$tableName}_{$field->column_name}";
1832       if (strlen($fkName) >= 48) {
1833         $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1834       }
1835       $params['fkName'] = $fkName;
1836     }
1837     if ($field->data_type == 'Country' && $field->html_type == 'Select Country') {
1838       $params['fk_table_name'] = 'civicrm_country';
1839       $params['fk_field_name'] = 'id';
1840       $params['fk_attributes'] = 'ON DELETE SET NULL';
1841     }
1842     elseif ($field->data_type == 'Country' && $field->html_type == 'Multi-Select Country') {
1843       $params['type'] = 'varchar(255)';
1844     }
1845     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Select State/Province') {
1846       $params['fk_table_name'] = 'civicrm_state_province';
1847       $params['fk_field_name'] = 'id';
1848       $params['fk_attributes'] = 'ON DELETE SET NULL';
1849     }
1850     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Multi-Select State/Province') {
1851       $params['type'] = 'varchar(255)';
1852     }
1853     elseif ($field->data_type == 'File') {
1854       $params['fk_table_name'] = 'civicrm_file';
1855       $params['fk_field_name'] = 'id';
1856       $params['fk_attributes'] = 'ON DELETE SET NULL';
1857     }
1858     elseif ($field->data_type == 'ContactReference') {
1859       $params['fk_table_name'] = 'civicrm_contact';
1860       $params['fk_field_name'] = 'id';
1861       $params['fk_attributes'] = 'ON DELETE SET NULL';
1862     }
1863     if (isset($field->default_value)) {
1864       $params['default'] = "'{$field->default_value}'";
1865     }
1866
1867     CRM_Core_BAO_SchemaHandler::alterFieldSQL($params, $indexExist, $triggerRebuild);
1868   }
1869
1870   /**
1871    * Determine whether it would be safe to move a field.
1872    *
1873    * @param int $fieldID
1874    *   FK to civicrm_custom_field.
1875    * @param int $newGroupID
1876    *   FK to civicrm_custom_group.
1877    *
1878    * @return array
1879    *   array(string) or TRUE
1880    */
1881   public static function _moveFieldValidate($fieldID, $newGroupID) {
1882     $errors = array();
1883
1884     $field = new CRM_Core_DAO_CustomField();
1885     $field->id = $fieldID;
1886     if (!$field->find(TRUE)) {
1887       $errors['fieldID'] = 'Invalid ID for custom field';
1888       return $errors;
1889     }
1890
1891     $oldGroup = new CRM_Core_DAO_CustomGroup();
1892     $oldGroup->id = $field->custom_group_id;
1893     if (!$oldGroup->find(TRUE)) {
1894       $errors['fieldID'] = 'Invalid ID for old custom group';
1895       return $errors;
1896     }
1897
1898     $newGroup = new CRM_Core_DAO_CustomGroup();
1899     $newGroup->id = $newGroupID;
1900     if (!$newGroup->find(TRUE)) {
1901       $errors['newGroupID'] = 'Invalid ID for new custom group';
1902       return $errors;
1903     }
1904
1905     $query = "
1906 SELECT     b.id
1907 FROM       civicrm_custom_field a
1908 INNER JOIN civicrm_custom_field b
1909 WHERE      a.id = %1
1910 AND        a.label = b.label
1911 AND        b.custom_group_id = %2
1912 ";
1913     $params = array(
1914       1 => array($field->id, 'Integer'),
1915       2 => array($newGroup->id, 'Integer'),
1916     );
1917     $count = CRM_Core_DAO::singleValueQuery($query, $params);
1918     if ($count > 0) {
1919       $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1920     }
1921
1922     $tableName = $oldGroup->table_name;
1923     $columnName = $field->column_name;
1924
1925     $query = "
1926 SELECT count(*)
1927 FROM   $tableName
1928 WHERE  $columnName is not null
1929 ";
1930     $count = CRM_Core_DAO::singleValueQuery($query,
1931       CRM_Core_DAO::$_nullArray
1932     );
1933     if ($count > 0) {
1934       $query = "
1935 SELECT extends
1936 FROM   civicrm_custom_group
1937 WHERE  id IN ( %1, %2 )
1938 ";
1939       $params = array(
1940         1 => array($oldGroup->id, 'Integer'),
1941         2 => array($newGroup->id, 'Integer'),
1942       );
1943
1944       $dao = CRM_Core_DAO::executeQuery($query, $params);
1945       $extends = array();
1946       while ($dao->fetch()) {
1947         $extends[] = $dao->extends;
1948       }
1949       if ($extends[0] != $extends[1]) {
1950         $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1951       }
1952     }
1953
1954     return empty($errors) ? TRUE : $errors;
1955   }
1956
1957   /**
1958    * Move a custom data field from one group (table) to another.
1959    *
1960    * @param int $fieldID
1961    *   FK to civicrm_custom_field.
1962    * @param int $newGroupID
1963    *   FK to civicrm_custom_group.
1964    */
1965   public static function moveField($fieldID, $newGroupID) {
1966     $validation = self::_moveFieldValidate($fieldID, $newGroupID);
1967     if (TRUE !== $validation) {
1968       CRM_Core_Error::fatal(implode(' ', $validation));
1969     }
1970     $field = new CRM_Core_DAO_CustomField();
1971     $field->id = $fieldID;
1972     $field->find(TRUE);
1973
1974     $newGroup = new CRM_Core_DAO_CustomGroup();
1975     $newGroup->id = $newGroupID;
1976     $newGroup->find(TRUE);
1977
1978     $oldGroup = new CRM_Core_DAO_CustomGroup();
1979     $oldGroup->id = $field->custom_group_id;
1980     $oldGroup->find(TRUE);
1981
1982     $add = clone$field;
1983     $add->custom_group_id = $newGroup->id;
1984     self::createField($add, 'add');
1985
1986     $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
1987             SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
1988             ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
1989             ";
1990     CRM_Core_DAO::executeQuery($sql);
1991
1992     $del = clone$field;
1993     $del->custom_group_id = $oldGroup->id;
1994     self::createField($del, 'delete');
1995
1996     $add->save();
1997
1998     CRM_Utils_System::flushCache();
1999   }
2000
2001   /**
2002    * Get the database table name and column name for a custom field.
2003    *
2004    * @param int $fieldID
2005    *   The fieldID of the custom field.
2006    * @param bool $force
2007    *   Force the sql to be run again (primarily used for tests).
2008    *
2009    * @return array
2010    *   fatal is fieldID does not exists, else array of tableName, columnName
2011    */
2012   public static function getTableColumnGroup($fieldID, $force = FALSE) {
2013     $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2014     $cache = CRM_Utils_Cache::singleton();
2015     $fieldValues = $cache->get($cacheKey);
2016     if (empty($fieldValues) || $force) {
2017       $query = "
2018 SELECT cg.table_name, cf.column_name, cg.id
2019 FROM   civicrm_custom_group cg,
2020        civicrm_custom_field cf
2021 WHERE  cf.custom_group_id = cg.id
2022 AND    cf.id = %1";
2023       $params = array(1 => array($fieldID, 'Integer'));
2024       $dao = CRM_Core_DAO::executeQuery($query, $params);
2025
2026       if (!$dao->fetch()) {
2027         CRM_Core_Error::fatal();
2028       }
2029       $dao->free();
2030       $fieldValues = array($dao->table_name, $dao->column_name, $dao->id);
2031       $cache->set($cacheKey, $fieldValues);
2032     }
2033     return $fieldValues;
2034   }
2035
2036   /**
2037    * Get custom option groups.
2038    *
2039    * @deprecated Use the API OptionGroup.get
2040    *
2041    * @param array $includeFieldIds
2042    *   Ids of custom fields for which option groups must be included.
2043    *
2044    * Currently this is required in the cases where option groups are to be included
2045    * for inactive fields : CRM-5369
2046    *
2047    * @return mixed
2048    */
2049   public static function customOptionGroup($includeFieldIds = NULL) {
2050     static $customOptionGroup = NULL;
2051
2052     $cacheKey = (empty($includeFieldIds)) ? 'onlyActive' : 'force';
2053     if ($cacheKey == 'force') {
2054       $customOptionGroup[$cacheKey] = NULL;
2055     }
2056
2057     if (empty($customOptionGroup[$cacheKey])) {
2058       $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2059
2060       //support for single as well as array format.
2061       if (!empty($includeFieldIds)) {
2062         if (is_array($includeFieldIds)) {
2063           $includeFieldIds = implode(',', $includeFieldIds);
2064         }
2065         $whereClause .= "OR f.id IN ( $includeFieldIds )";
2066       }
2067
2068       $query = "
2069     SELECT  g.id, g.title
2070       FROM  civicrm_option_group g
2071 INNER JOIN  civicrm_custom_field f ON ( g.id = f.option_group_id )
2072      WHERE  {$whereClause}";
2073
2074       $dao = CRM_Core_DAO::executeQuery($query);
2075       while ($dao->fetch()) {
2076         $customOptionGroup[$cacheKey][$dao->id] = $dao->title;
2077       }
2078     }
2079
2080     return $customOptionGroup[$cacheKey];
2081   }
2082
2083   /**
2084    * Fix orphan groups.
2085    *
2086    * @param int $customFieldId
2087    *   Custom field id.
2088    * @param int $optionGroupId
2089    *   Option group id.
2090    */
2091   public static function fixOptionGroups($customFieldId, $optionGroupId) {
2092     // check if option group belongs to any custom Field else delete
2093     // get the current option group
2094     $currentOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
2095       $customFieldId,
2096       'option_group_id'
2097     );
2098     // get the updated option group
2099     // if both are same return
2100     if ($currentOptionGroupId == $optionGroupId) {
2101       return;
2102     }
2103
2104     // check if option group is related to any other field
2105     self::checkOptionGroup($currentOptionGroupId);
2106   }
2107
2108   /**
2109    * Check if option group is related to more than one custom field.
2110    *
2111    * @param int $optionGroupId
2112    *   Option group id.
2113    */
2114   public static function checkOptionGroup($optionGroupId) {
2115     $query = "
2116 SELECT count(*)
2117 FROM   civicrm_custom_field
2118 WHERE  option_group_id = {$optionGroupId}";
2119
2120     $count = CRM_Core_DAO::singleValueQuery($query);
2121
2122     if ($count < 2) {
2123       //delete the option group
2124       CRM_Core_BAO_OptionGroup::del($optionGroupId);
2125     }
2126   }
2127
2128   /**
2129    * Get option group default.
2130    *
2131    * @param int $optionGroupId
2132    * @param string $htmlType
2133    *
2134    * @return null|string
2135    */
2136   public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2137     $query = "
2138 SELECT   default_value, html_type
2139 FROM     civicrm_custom_field
2140 WHERE    option_group_id = {$optionGroupId}
2141 AND      default_value IS NOT NULL
2142 ORDER BY html_type";
2143
2144     $dao = CRM_Core_DAO::executeQuery($query);
2145     $defaultValue = NULL;
2146     $defaultHTMLType = NULL;
2147     while ($dao->fetch()) {
2148       if ($dao->html_type == $htmlType) {
2149         return $dao->default_value;
2150       }
2151       if ($defaultValue == NULL) {
2152         $defaultValue = $dao->default_value;
2153         $defaultHTMLType = $dao->html_type;
2154       }
2155     }
2156
2157     // some conversions are needed if either the old or new has a html type which has potential
2158     // multiple default values.
2159     if (($htmlType == 'CheckBox' || $htmlType == 'Multi-Select') &&
2160       ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2161     ) {
2162       $defaultValue = CRM_Core_DAO::VALUE_SEPARATOR . $defaultValue . CRM_Core_DAO::VALUE_SEPARATOR;
2163     }
2164     elseif (($defaultHTMLType == 'CheckBox' || $defaultHTMLType == 'Multi-Select') &&
2165       ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2166     ) {
2167       $defaultValue = substr($defaultValue, 1, -1);
2168       $values = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2169         substr($defaultValue, 1, -1)
2170       );
2171       $defaultValue = $values[0];
2172     }
2173
2174     return $defaultValue;
2175   }
2176
2177   /**
2178    * Post process function.
2179    *
2180    * @param array $params
2181    * @param int $entityID
2182    * @param string $customFieldExtends
2183    * @param bool $inline
2184    * @param bool $checkPermissions
2185    *
2186    * @return array
2187    */
2188   public static function postProcess(
2189     &$params,
2190     $entityID,
2191     $customFieldExtends,
2192     $inline = FALSE,
2193     $checkPermissions = TRUE
2194   ) {
2195     $customData = array();
2196
2197     foreach ($params as $key => $value) {
2198       if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE)) {
2199
2200         // for autocomplete transfer hidden value instead of label
2201         if ($params[$key] && isset($params[$key . '_id'])) {
2202           $value = $params[$key . '_id'];
2203         }
2204
2205         // we need to append time with date
2206         if ($params[$key] && isset($params[$key . '_time'])) {
2207           $value .= ' ' . $params[$key . '_time'];
2208         }
2209
2210         CRM_Core_BAO_CustomField::formatCustomField($customFieldInfo[0],
2211           $customData,
2212           $value,
2213           $customFieldExtends,
2214           $customFieldInfo[1],
2215           $entityID,
2216           $inline,
2217           $checkPermissions
2218         );
2219       }
2220     }
2221     return $customData;
2222   }
2223
2224   /**
2225    * Get custom field ID from field/group name/title.
2226    *
2227    * @param string $fieldName Field name or label
2228    * @param string|null $groupTitle (Optional) Group name or label
2229    * @param bool $fullString Whether to return "custom_123" or "123"
2230    *
2231    * @return string|int|null
2232    * @throws \CiviCRM_API3_Exception
2233    */
2234   public static function getCustomFieldID($fieldName, $groupTitle = NULL, $fullString = FALSE) {
2235     if (!isset(Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName])) {
2236       $customFieldParams = [
2237         'name' => $fieldName,
2238         'label' => $fieldName,
2239         'options' => ['or' => [["name", "label"]]],
2240       ];
2241
2242       if ($groupTitle) {
2243         $customFieldParams['custom_group_id.name'] = $groupTitle;
2244         $customFieldParams['custom_group_id.title'] = $groupTitle;
2245         $customFieldParams['options'] = ['or' => [["name", "label"], ["custom_group_id.name", "custom_group_id.title"]]];
2246       }
2247
2248       $field = civicrm_api3('CustomField', 'get', $customFieldParams);
2249
2250       if (empty($field['id'])) {
2251         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = NULL;
2252         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = NULL;
2253       }
2254       else {
2255         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = $field['id'];
2256         Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = 'custom_' . $field['id'];
2257       }
2258     }
2259
2260     if ($fullString) {
2261       return Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'];
2262     }
2263     return Civi::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'];
2264   }
2265
2266   /**
2267    * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2268    *
2269    * @param array $ids
2270    *
2271    * @return array
2272    */
2273   public static function getNameFromID($ids) {
2274     if (is_array($ids)) {
2275       $ids = implode(',', $ids);
2276     }
2277     $sql = "
2278 SELECT     f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2279 FROM       civicrm_custom_field f
2280 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2281 WHERE      f.id IN ($ids)";
2282
2283     $dao = CRM_Core_DAO::executeQuery($sql);
2284     $result = array();
2285     while ($dao->fetch()) {
2286       $result[$dao->id] = array(
2287         'field_name' => $dao->field_name,
2288         'field_label' => $dao->field_label,
2289         'group_name' => $dao->group_name,
2290         'group_title' => $dao->group_title,
2291       );
2292     }
2293     return $result;
2294   }
2295
2296   /**
2297    * Validate custom data.
2298    *
2299    * @param array $params
2300    *   Custom data submitted.
2301    *   ie array( 'custom_1' => 'validate me' );
2302    *
2303    * @return array
2304    *   validation errors.
2305    */
2306   public static function validateCustomData($params) {
2307     $errors = array();
2308     if (!is_array($params) || empty($params)) {
2309       return $errors;
2310     }
2311
2312     //pick up profile fields.
2313     $profileFields = array();
2314     $ufGroupId = CRM_Utils_Array::value('ufGroupId', $params);
2315     if ($ufGroupId) {
2316       $profileFields = CRM_Core_BAO_UFGroup::getFields($ufGroupId,
2317         FALSE,
2318         CRM_Core_Action::VIEW
2319       );
2320     }
2321
2322     //lets start w/ params.
2323     foreach ($params as $key => $value) {
2324       $customFieldID = self::getKeyID($key);
2325       if (!$customFieldID) {
2326         continue;
2327       }
2328
2329       //load the structural info for given field.
2330       $field = new CRM_Core_DAO_CustomField();
2331       $field->id = $customFieldID;
2332       if (!$field->find(TRUE)) {
2333         continue;
2334       }
2335       $dataType = $field->data_type;
2336
2337       $profileField = CRM_Utils_Array::value($key, $profileFields, array());
2338       $fieldTitle = CRM_Utils_Array::value('title', $profileField);
2339       $isRequired = CRM_Utils_Array::value('is_required', $profileField);
2340       if (!$fieldTitle) {
2341         $fieldTitle = $field->label;
2342       }
2343
2344       //no need to validate.
2345       if (CRM_Utils_System::isNull($value) && !$isRequired) {
2346         continue;
2347       }
2348
2349       //lets validate first for required field.
2350       if ($isRequired && CRM_Utils_System::isNull($value)) {
2351         $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2352         continue;
2353       }
2354
2355       //now time to take care of custom field form rules.
2356       $ruleName = $errorMsg = NULL;
2357       switch ($dataType) {
2358         case 'Int':
2359           $ruleName = 'integer';
2360           $errorMsg = ts('%1 must be an integer (whole number).',
2361             array(1 => $fieldTitle)
2362           );
2363           break;
2364
2365         case 'Money':
2366           $ruleName = 'money';
2367           $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2368             array(1 => $fieldTitle)
2369           );
2370           break;
2371
2372         case 'Float':
2373           $ruleName = 'numeric';
2374           $errorMsg = ts('%1 must be a number (with or without decimal point).',
2375             array(1 => $fieldTitle)
2376           );
2377           break;
2378
2379         case 'Link':
2380           $ruleName = 'wikiURL';
2381           $errorMsg = ts('%1 must be valid Website.',
2382             array(1 => $fieldTitle)
2383           );
2384           break;
2385       }
2386
2387       if ($ruleName && !CRM_Utils_System::isNull($value)) {
2388         $valid = FALSE;
2389         $funName = "CRM_Utils_Rule::{$ruleName}";
2390         if (is_callable($funName)) {
2391           $valid = call_user_func($funName, $value);
2392         }
2393         if (!$valid) {
2394           $errors[$key] = $errorMsg;
2395         }
2396       }
2397     }
2398
2399     return $errors;
2400   }
2401
2402   /**
2403    * Is this field a multi record field.
2404    *
2405    * @param int $customId
2406    *
2407    * @return bool
2408    */
2409   public static function isMultiRecordField($customId) {
2410     $isMultipleWithGid = FALSE;
2411     if (!is_numeric($customId)) {
2412       $customId = self::getKeyID($customId);
2413     }
2414     if (is_numeric($customId)) {
2415       $sql = "SELECT cg.id cgId
2416  FROM civicrm_custom_group cg
2417  INNER JOIN civicrm_custom_field cf
2418  ON cg.id = cf.custom_group_id
2419 WHERE cf.id = %1 AND cg.is_multiple = 1";
2420       $params[1] = array($customId, 'Integer');
2421       $dao = CRM_Core_DAO::executeQuery($sql, $params);
2422       if ($dao->fetch()) {
2423         if ($dao->cgId) {
2424           $isMultipleWithGid = $dao->cgId;
2425         }
2426       }
2427     }
2428
2429     return $isMultipleWithGid;
2430   }
2431
2432   /**
2433    * Does this field store a serialized string?
2434    *
2435    * @param array $field
2436    *
2437    * @return bool
2438    */
2439   public static function isSerialized($field) {
2440     // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2441     $field = (array) $field;
2442     // 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.
2443     return ($field['html_type'] == 'CheckBox' || strpos($field['html_type'], 'Multi') !== FALSE);
2444   }
2445
2446   /**
2447    * Get api entity for this field
2448    *
2449    * @return string
2450    */
2451   public function getEntity() {
2452     $entity = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->custom_group_id, 'extends');
2453     return in_array($entity, array('Individual', 'Household', 'Organization')) ? 'Contact' : $entity;
2454   }
2455
2456   /**
2457    * Set pseudoconstant properties for field metadata.
2458    *
2459    * @param array $field
2460    * @param string|null $optionGroupName
2461    */
2462   private static function getOptionsForField(&$field, $optionGroupName) {
2463     if ($optionGroupName) {
2464       $field['pseudoconstant'] = array(
2465         'optionGroupName' => $optionGroupName,
2466         'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2467       );
2468     }
2469     elseif ($field['data_type'] == 'Boolean') {
2470       $field['pseudoconstant'] = array(
2471         'callback' => 'CRM_Core_SelectValues::boolean',
2472       );
2473     }
2474     elseif ($field['data_type'] == 'Country') {
2475       $field['pseudoconstant'] = array(
2476         'table' => 'civicrm_country',
2477         'keyColumn' => 'id',
2478         'labelColumn' => 'name',
2479         'nameColumn' => 'iso_code',
2480       );
2481     }
2482     elseif ($field['data_type'] == 'StateProvince') {
2483       $field['pseudoconstant'] = array(
2484         'table' => 'civicrm_state_province',
2485         'keyColumn' => 'id',
2486         'labelColumn' => 'name',
2487       );
2488     }
2489   }
2490
2491 }