CRM/Core/BAO/CustomField.php

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