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         // In the context of displaying a profile, show file/image
1321         if ($contactID && $value) {
1322           $url = self::getFileURL($contactID, $fieldID, $value);
1323           if ($url) {
1324             $display = $url['file_url'];
1325           }
1326         }
1327         // In other contexts show a paperclip icon
1328         elseif ($value) {
1329           $icons = CRM_Core_BAO_File::paperIconAttachment('*', $value);
1330           $display = $icons[$value];
1331         }
1332         break;
1333
1334       case 'TextArea':
1335         if (empty($value)) {
1336           $display = '';
1337         }
1338         else {
1339           $display = nl2br($value);
1340         }
1341         break;
1342
1343       case 'Link':
1344         if (empty($value)) {
1345           $display = '';
1346         }
1347         else {
1348           $display = $value;
1349         }
1350     }
1351     return $display ? $display : $value;
1352   }
1353
1354   /**
1355    * Set default values for custom data used in profile.
1356    *
1357    * @param int $customFieldId
1358    *   Custom field id.
1359    * @param string $elementName
1360    *   Custom field name.
1361    * @param array $defaults
1362    *   Associated array of fields.
1363    * @param int $contactId
1364    *   Contact id.
1365    * @param int $mode
1366    *   Profile mode.
1367    * @param mixed $value
1368    *   If passed - dont fetch value from db,.
1369    *                               just format the given value
1370    *
1371    */
1372   public static function setProfileDefaults(
1373     $customFieldId,
1374     $elementName,
1375     &$defaults,
1376     $contactId = NULL,
1377     $mode = NULL,
1378     $value = NULL
1379   ) {
1380     //get the type of custom field
1381     $customField = new CRM_Core_BAO_CustomField();
1382     $customField->id = $customFieldId;
1383     $customField->find(TRUE);
1384
1385     if (!$contactId) {
1386       if ($mode == CRM_Profile_Form::MODE_CREATE) {
1387         $value = $customField->default_value;
1388       }
1389     }
1390     else {
1391       if (!isset($value)) {
1392         $info = self::getTableColumnGroup($customFieldId);
1393         $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1394         $result = CRM_Core_DAO::executeQuery($query);
1395         if ($result->fetch()) {
1396           $value = $result->value;
1397         }
1398       }
1399
1400       if ($customField->data_type == 'Country') {
1401         if (!$value) {
1402           $config = CRM_Core_Config::singleton();
1403           if ($config->defaultContactCountry) {
1404             $value = $config->defaultContactCountry();
1405           }
1406         }
1407       }
1408     }
1409
1410     //set defaults if mode is registration
1411     if (!trim($value) &&
1412       ($value !== 0) &&
1413       (!in_array($mode, array(CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)))
1414     ) {
1415       $value = $customField->default_value;
1416     }
1417
1418     if ($customField->data_type == 'Money' && isset($value)) {
1419       $value = number_format($value, 2);
1420     }
1421     switch ($customField->html_type) {
1422       case 'CheckBox':
1423       case 'AdvMulti-Select':
1424       case 'Multi-Select':
1425         $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldId, FALSE);
1426         $defaults[$elementName] = array();
1427         $checkedValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1428           substr($value, 1, -1)
1429         );
1430         foreach ($customOption as $val) {
1431           if (in_array($val['value'], $checkedValue)) {
1432             if ($customField->html_type == 'CheckBox') {
1433               $defaults[$elementName][$val['value']] = 1;
1434             }
1435             elseif ($customField->html_type == 'Multi-Select' ||
1436               $customField->html_type == 'AdvMulti-Select'
1437             ) {
1438               $defaults[$elementName][$val['value']] = $val['value'];
1439             }
1440           }
1441         }
1442         break;
1443
1444       case 'Select Date':
1445         if ($value) {
1446           list($defaults[$elementName], $defaults[$elementName . '_time']) = CRM_Utils_Date::setDateDefaults(
1447             $value,
1448             NULL,
1449             $customField->date_format,
1450             $customField->time_format
1451           );
1452         }
1453         break;
1454
1455       case 'Autocomplete-Select':
1456         if ($customField->data_type == 'ContactReference') {
1457           if (is_numeric($value)) {
1458             $defaults[$elementName . '_id'] = $value;
1459             $defaults[$elementName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1460           }
1461         }
1462         else {
1463           $defaults[$elementName] = $value;
1464         }
1465         break;
1466
1467       default:
1468         $defaults[$elementName] = $value;
1469     }
1470   }
1471
1472   /**
1473    * @param int $contactID
1474    * @param int $cfID
1475    * @param int $fileID
1476    * @param bool $absolute
1477    *
1478    * @return array
1479    */
1480   /**
1481    * @param int $contactID
1482    * @param int $cfID
1483    * @param int $fileID
1484    * @param bool $absolute
1485    *
1486    * @return array
1487    */
1488   public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1489     if ($contactID) {
1490       if (!$fileID) {
1491         $params = array('id' => $cfID);
1492         $defaults = array();
1493         CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1494         $columnName = $defaults['column_name'];
1495
1496         //table name of custom data
1497         $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
1498           $defaults['custom_group_id'],
1499           'table_name', 'id'
1500         );
1501
1502         //query to fetch id from civicrm_file
1503         if ($multiRecordWhereClause) {
1504           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1505         }
1506         else {
1507           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1508         }
1509         $fileID = CRM_Core_DAO::singleValueQuery($query);
1510       }
1511
1512       $result = array();
1513       if ($fileID) {
1514         $fileType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1515           $fileID,
1516           'mime_type',
1517           'id'
1518         );
1519         $result['file_id'] = $fileID;
1520
1521         if ($fileType == 'image/jpeg' ||
1522           $fileType == 'image/pjpeg' ||
1523           $fileType == 'image/gif' ||
1524           $fileType == 'image/x-png' ||
1525           $fileType == 'image/png'
1526         ) {
1527           $entityId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile',
1528             $fileID,
1529             'entity_id',
1530             'id'
1531           );
1532           list($path) = CRM_Core_BAO_File::path($fileID, $entityId, NULL, NULL);
1533           list($imageWidth, $imageHeight) = getimagesize($path);
1534           list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
1535           $url = CRM_Utils_System::url('civicrm/file',
1536             "reset=1&id=$fileID&eid=$contactID",
1537             $absolute, NULL, TRUE, TRUE
1538           );
1539           $result['file_url'] = "
1540           <a href=\"$url\" class='crm-image-popup'>
1541           <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
1542           </a>";
1543           // for non image files
1544         }
1545         else {
1546           $uri = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1547             $fileID,
1548             'uri'
1549           );
1550           $url = CRM_Utils_System::url('civicrm/file',
1551             "reset=1&id=$fileID&eid=$contactID",
1552             $absolute, NULL, TRUE, TRUE
1553           );
1554           $result['file_url'] = "<a href=\"$url\">{$uri}</a>";
1555         }
1556       }
1557       return $result;
1558     }
1559   }
1560
1561   /**
1562    * Format custom fields before inserting.
1563    *
1564    * @param int $customFieldId
1565    *   Custom field id.
1566    * @param array $customFormatted
1567    *   Formatted array.
1568    * @param mix $value
1569    *   Value of custom field.
1570    * @param string $customFieldExtend
1571    *   Custom field extends.
1572    * @param int $customValueId
1573    *   Custom option value id.
1574    * @param int $entityId
1575    *   Entity id (contribution, membership...).
1576    * @param bool $inline
1577    *   Consider inline custom groups only.
1578    * @param bool $checkPermission
1579    *   If false, do not include permissioning clause.
1580    * @param bool $includeViewOnly
1581    *   If true, fields marked 'View Only' are included. Required for APIv3.
1582    *
1583    * @return array|NULL
1584    *   formatted custom field array
1585    */
1586   public static function formatCustomField(
1587     $customFieldId, &$customFormatted, $value,
1588     $customFieldExtend, $customValueId = NULL,
1589     $entityId = NULL,
1590     $inline = FALSE,
1591     $checkPermission = TRUE,
1592     $includeViewOnly = FALSE
1593   ) {
1594     //get the custom fields for the entity
1595     //subtype and basic type
1596     $customDataSubType = NULL;
1597     if (is_array($customFieldExtend)) {
1598       // This is the case when getFieldsForImport() requires fields
1599       // of subtype and its parent.CRM-5143
1600       // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1601       $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType::subTypes(), (array) $customFieldExtend);
1602       if (!empty($customDataSubType) && is_array($customDataSubType)) {
1603         $customFieldExtend = array_unique(array_values(CRM_Contact_BAO_ContactType::getBasicType($customDataSubType)));
1604       }
1605     }
1606
1607     $customFields = CRM_Core_BAO_CustomField::getFields($customFieldExtend,
1608       FALSE,
1609       $inline,
1610       $customDataSubType,
1611       NULL,
1612       FALSE,
1613       FALSE,
1614       $checkPermission
1615     );
1616
1617     if (!array_key_exists($customFieldId, $customFields)) {
1618       return NULL;
1619     }
1620
1621     // return if field is a 'code' field
1622     if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1623       return NULL;
1624     }
1625
1626     list($tableName, $columnName, $groupID) = self::getTableColumnGroup($customFieldId);
1627
1628     if (!$customValueId &&
1629       // we always create new entites for is_multiple unless specified
1630       !$customFields[$customFieldId]['is_multiple'] &&
1631       $entityId
1632     ) {
1633       $query = "
1634 SELECT id
1635   FROM $tableName
1636  WHERE entity_id={$entityId}";
1637
1638       $customValueId = CRM_Core_DAO::singleValueQuery($query);
1639     }
1640
1641     //fix checkbox, now check box always submits values
1642     if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1643       if ($value) {
1644         // Note that only during merge this is not an array, and you can directly use value
1645         if (is_array($value)) {
1646           $selectedValues = array();
1647           foreach ($value as $selId => $val) {
1648             if ($val) {
1649               $selectedValues[] = $selId;
1650             }
1651           }
1652           if (!empty($selectedValues)) {
1653             $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1654                 $selectedValues
1655               ) . CRM_Core_DAO::VALUE_SEPARATOR;
1656           }
1657           else {
1658             $value = '';
1659           }
1660         }
1661       }
1662     }
1663
1664     if ($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1665       $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select'
1666     ) {
1667       if ($value) {
1668         // Note that only during merge this is not an array,
1669         // and you can directly use value, CRM-4385
1670         if (is_array($value)) {
1671           $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1672               array_values($value)
1673             ) . CRM_Core_DAO::VALUE_SEPARATOR;
1674         }
1675       }
1676       else {
1677         $value = '';
1678       }
1679     }
1680
1681     if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1682         $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select' ||
1683         $customFields[$customFieldId]['html_type'] == 'CheckBox'
1684       ) &&
1685       $customFields[$customFieldId]['data_type'] == 'String' &&
1686       !empty($customFields[$customFieldId]['text_length']) &&
1687       !empty($value)
1688     ) {
1689       // lets make sure that value is less than the length, else we'll
1690       // be losing some data, CRM-7481
1691       if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1692         // need to do a few things here
1693
1694         // 1. lets find a new length
1695         $newLength = $customFields[$customFieldId]['text_length'];
1696         $minLength = strlen($value);
1697         while ($newLength < $minLength) {
1698           $newLength = $newLength * 2;
1699         }
1700
1701         // set the custom field meta data to have a length larger than value
1702         // alter the custom value table column to match this length
1703         CRM_Core_BAO_SchemaHandler::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1704       }
1705     }
1706
1707     $date = NULL;
1708     if ($customFields[$customFieldId]['data_type'] == 'Date') {
1709       if (!CRM_Utils_System::isNull($value)) {
1710         $format = $customFields[$customFieldId]['date_format'];
1711         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, 'YmdHis', $format);
1712       }
1713       $value = $date;
1714     }
1715
1716     if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1717       $customFields[$customFieldId]['data_type'] == 'Money'
1718     ) {
1719       if (!$value) {
1720         $value = 0;
1721       }
1722
1723       if ($customFields[$customFieldId]['data_type'] == 'Money') {
1724         $value = CRM_Utils_Rule::cleanMoney($value);
1725       }
1726     }
1727
1728     if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1729         $customFields[$customFieldId]['data_type'] == 'Country'
1730       ) &&
1731       empty($value)
1732     ) {
1733       // CRM-3415
1734       $value = 0;
1735     }
1736
1737     $fileId = NULL;
1738
1739     if ($customFields[$customFieldId]['data_type'] == 'File') {
1740       if (empty($value)) {
1741         return;
1742       }
1743
1744       $config = CRM_Core_Config::singleton();
1745
1746       $fName = $value['name'];
1747       $mimeType = $value['type'];
1748
1749       $filename = pathinfo($fName, PATHINFO_BASENAME);
1750
1751       // rename this file to go into the secure directory
1752       if (!rename($fName, $config->customFileUploadDir . $filename)) {
1753         CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory'));
1754       }
1755
1756       if ($customValueId) {
1757         $query = "
1758 SELECT $columnName
1759   FROM $tableName
1760  WHERE id = %1";
1761         $params = array(1 => array($customValueId, 'Integer'));
1762         $fileId = CRM_Core_DAO::singleValueQuery($query, $params);
1763       }
1764
1765       $fileDAO = new CRM_Core_DAO_File();
1766
1767       if ($fileId) {
1768         $fileDAO->id = $fileId;
1769       }
1770
1771       $fileDAO->uri = $filename;
1772       $fileDAO->mime_type = $mimeType;
1773       $fileDAO->upload_date = date('Ymdhis');
1774       $fileDAO->save();
1775       $fileId = $fileDAO->id;
1776       $value = $filename;
1777     }
1778
1779     if (!is_array($customFormatted)) {
1780       $customFormatted = array();
1781     }
1782
1783     if (!array_key_exists($customFieldId, $customFormatted)) {
1784       $customFormatted[$customFieldId] = array();
1785     }
1786
1787     $index = -1;
1788     if ($customValueId) {
1789       $index = $customValueId;
1790     }
1791
1792     if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1793       $customFormatted[$customFieldId][$index] = array();
1794     }
1795     $customFormatted[$customFieldId][$index] = array(
1796       'id' => $customValueId > 0 ? $customValueId : NULL,
1797       'value' => $value,
1798       'type' => $customFields[$customFieldId]['data_type'],
1799       'custom_field_id' => $customFieldId,
1800       'custom_group_id' => $groupID,
1801       'table_name' => $tableName,
1802       'column_name' => $columnName,
1803       'file_id' => $fileId,
1804       'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1805     );
1806
1807     //we need to sort so that custom fields are created in the order of entry
1808     krsort($customFormatted[$customFieldId]);
1809     return $customFormatted;
1810   }
1811
1812   /**
1813    * @param array $params
1814    *
1815    * @return array
1816    */
1817   public static function &defaultCustomTableSchema(&$params) {
1818     // add the id and extends_id
1819     $table = array(
1820       'name' => $params['name'],
1821       'is_multiple' => $params['is_multiple'],
1822       'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1823       'fields' => array(
1824         array(
1825           'name' => 'id',
1826           'type' => 'int unsigned',
1827           'primary' => TRUE,
1828           'required' => TRUE,
1829           'attributes' => 'AUTO_INCREMENT',
1830           'comment' => 'Default MySQL primary key',
1831         ),
1832         array(
1833           'name' => 'entity_id',
1834           'type' => 'int unsigned',
1835           'required' => TRUE,
1836           'comment' => 'Table that this extends',
1837           'fk_table_name' => $params['extends_name'],
1838           'fk_field_name' => 'id',
1839           'fk_attributes' => 'ON DELETE CASCADE',
1840         ),
1841       ),
1842     );
1843
1844     if (!$params['is_multiple']) {
1845       $table['indexes'] = array(
1846         array(
1847           'unique' => TRUE,
1848           'field_name_1' => 'entity_id',
1849         ),
1850       );
1851     }
1852     return $table;
1853   }
1854
1855   /**
1856    * @param $field
1857    * @param $operation
1858    * @param bool $indexExist
1859    * @param bool $triggerRebuild
1860    */
1861   public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1862     $tableName = CRM_Core_DAO::getFieldValue(
1863       'CRM_Core_DAO_CustomGroup',
1864       $field->custom_group_id,
1865       'table_name'
1866     );
1867
1868     $params = array(
1869       'table_name' => $tableName,
1870       'operation' => $operation,
1871       'name' => $field->column_name,
1872       'type' => CRM_Core_BAO_CustomValueTable::fieldToSQLType(
1873         $field->data_type,
1874         $field->text_length
1875       ),
1876       'required' => $field->is_required,
1877       'searchable' => $field->is_searchable,
1878     );
1879
1880     if ($operation == 'delete') {
1881       $fkName = "{$tableName}_{$field->column_name}";
1882       if (strlen($fkName) >= 48) {
1883         $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1884       }
1885       $params['fkName'] = $fkName;
1886     }
1887     if ($field->data_type == 'Country' && $field->html_type == 'Select Country') {
1888       $params['fk_table_name'] = 'civicrm_country';
1889       $params['fk_field_name'] = 'id';
1890       $params['fk_attributes'] = 'ON DELETE SET NULL';
1891     }
1892     elseif ($field->data_type == 'Country' && $field->html_type == 'Multi-Select Country') {
1893       $params['type'] = 'varchar(255)';
1894     }
1895     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Select State/Province') {
1896       $params['fk_table_name'] = 'civicrm_state_province';
1897       $params['fk_field_name'] = 'id';
1898       $params['fk_attributes'] = 'ON DELETE SET NULL';
1899     }
1900     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Multi-Select State/Province') {
1901       $params['type'] = 'varchar(255)';
1902     }
1903     elseif ($field->data_type == 'File') {
1904       $params['fk_table_name'] = 'civicrm_file';
1905       $params['fk_field_name'] = 'id';
1906       $params['fk_attributes'] = 'ON DELETE SET NULL';
1907     }
1908     elseif ($field->data_type == 'ContactReference') {
1909       $params['fk_table_name'] = 'civicrm_contact';
1910       $params['fk_field_name'] = 'id';
1911       $params['fk_attributes'] = 'ON DELETE SET NULL';
1912     }
1913     if (isset($field->default_value)) {
1914       $params['default'] = "'{$field->default_value}'";
1915     }
1916
1917     CRM_Core_BAO_SchemaHandler::alterFieldSQL($params, $indexExist, $triggerRebuild);
1918   }
1919
1920   /**
1921    * Determine whether it would be safe to move a field.
1922    *
1923    * @param int $fieldID
1924    *   FK to civicrm_custom_field.
1925    * @param int $newGroupID
1926    *   FK to civicrm_custom_group.
1927    *
1928    * @return array
1929    *   array(string) or TRUE
1930    */
1931   public static function _moveFieldValidate($fieldID, $newGroupID) {
1932     $errors = array();
1933
1934     $field = new CRM_Core_DAO_CustomField();
1935     $field->id = $fieldID;
1936     if (!$field->find(TRUE)) {
1937       $errors['fieldID'] = 'Invalid ID for custom field';
1938       return $errors;
1939     }
1940
1941     $oldGroup = new CRM_Core_DAO_CustomGroup();
1942     $oldGroup->id = $field->custom_group_id;
1943     if (!$oldGroup->find(TRUE)) {
1944       $errors['fieldID'] = 'Invalid ID for old custom group';
1945       return $errors;
1946     }
1947
1948     $newGroup = new CRM_Core_DAO_CustomGroup();
1949     $newGroup->id = $newGroupID;
1950     if (!$newGroup->find(TRUE)) {
1951       $errors['newGroupID'] = 'Invalid ID for new custom group';
1952       return $errors;
1953     }
1954
1955     $query = "
1956 SELECT     b.id
1957 FROM       civicrm_custom_field a
1958 INNER JOIN civicrm_custom_field b
1959 WHERE      a.id = %1
1960 AND        a.label = b.label
1961 AND        b.custom_group_id = %2
1962 ";
1963     $params = array(
1964       1 => array($field->id, 'Integer'),
1965       2 => array($newGroup->id, 'Integer'),
1966     );
1967     $count = CRM_Core_DAO::singleValueQuery($query, $params);
1968     if ($count > 0) {
1969       $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1970     }
1971
1972     $tableName = $oldGroup->table_name;
1973     $columnName = $field->column_name;
1974
1975     $query = "
1976 SELECT count(*)
1977 FROM   $tableName
1978 WHERE  $columnName is not null
1979 ";
1980     $count = CRM_Core_DAO::singleValueQuery($query,
1981       CRM_Core_DAO::$_nullArray
1982     );
1983     if ($count > 0) {
1984       $query = "
1985 SELECT extends
1986 FROM   civicrm_custom_group
1987 WHERE  id IN ( %1, %2 )
1988 ";
1989       $params = array(
1990         1 => array($oldGroup->id, 'Integer'),
1991         2 => array($newGroup->id, 'Integer'),
1992       );
1993
1994       $dao = CRM_Core_DAO::executeQuery($query, $params);
1995       $extends = array();
1996       while ($dao->fetch()) {
1997         $extends[] = $dao->extends;
1998       }
1999       if ($extends[0] != $extends[1]) {
2000         $errors['newGroupID'] = ts('The destination group extends a different entity type.');
2001       }
2002     }
2003
2004     return empty($errors) ? TRUE : $errors;
2005   }
2006
2007   /**
2008    * Move a custom data field from one group (table) to another
2009    *
2010    * @param int $fieldID
2011    *   FK to civicrm_custom_field.
2012    * @param int $newGroupID
2013    *   FK to civicrm_custom_group.
2014    *
2015    * @return void
2016    */
2017   public static function moveField($fieldID, $newGroupID) {
2018     $validation = self::_moveFieldValidate($fieldID, $newGroupID);
2019     if (TRUE !== $validation) {
2020       CRM_Core_Error::fatal(implode(' ', $validation));
2021     }
2022     $field = new CRM_Core_DAO_CustomField();
2023     $field->id = $fieldID;
2024     $field->find(TRUE);
2025
2026     $newGroup = new CRM_Core_DAO_CustomGroup();
2027     $newGroup->id = $newGroupID;
2028     $newGroup->find(TRUE);
2029
2030     $oldGroup = new CRM_Core_DAO_CustomGroup();
2031     $oldGroup->id = $field->custom_group_id;
2032     $oldGroup->find(TRUE);
2033
2034     $add = clone$field;
2035     $add->custom_group_id = $newGroup->id;
2036     self::createField($add, 'add');
2037
2038     $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
2039             SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
2040             ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
2041             ";
2042     CRM_Core_DAO::executeQuery($sql);
2043
2044     $del = clone$field;
2045     $del->custom_group_id = $oldGroup->id;
2046     self::createField($del, 'delete');
2047
2048     $add->save();
2049
2050     CRM_Utils_System::flushCache();
2051   }
2052
2053   /**
2054    * Get the database table name and column name for a custom field.
2055    *
2056    * @param int $fieldID
2057    *   The fieldID of the custom field.
2058    * @param bool $force
2059    *   Force the sql to be run again (primarily used for tests).
2060    *
2061    * @return array
2062    *   fatal is fieldID does not exists, else array of tableName, columnName
2063    */
2064   public static function getTableColumnGroup($fieldID, $force = FALSE) {
2065     $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2066     $cache = CRM_Utils_Cache::singleton();
2067     $fieldValues = $cache->get($cacheKey);
2068     if (empty($fieldValues) || $force) {
2069       $query = "
2070 SELECT cg.table_name, cf.column_name, cg.id
2071 FROM   civicrm_custom_group cg,
2072        civicrm_custom_field cf
2073 WHERE  cf.custom_group_id = cg.id
2074 AND    cf.id = %1";
2075       $params = array(1 => array($fieldID, 'Integer'));
2076       $dao = CRM_Core_DAO::executeQuery($query, $params);
2077
2078       if (!$dao->fetch()) {
2079         CRM_Core_Error::fatal();
2080       }
2081       $dao->free();
2082       $fieldValues = array($dao->table_name, $dao->column_name, $dao->id);
2083       $cache->set($cacheKey, $fieldValues);
2084     }
2085     return $fieldValues;
2086   }
2087
2088   /**
2089    * Get custom option groups.
2090    *
2091    * @param array $includeFieldIds
2092    *   Ids of custom fields for which.
2093    *   option groups must be included.
2094    *
2095    * Currently this is required in the cases where option groups are to be included
2096    * for inactive fields : CRM-5369
2097    *
2098    *
2099    * @return mixed
2100    */
2101   public static function &customOptionGroup($includeFieldIds = NULL) {
2102     static $customOptionGroup = NULL;
2103
2104     $cacheKey = (empty($includeFieldIds)) ? 'onlyActive' : 'force';
2105     if ($cacheKey == 'force') {
2106       $customOptionGroup[$cacheKey] = NULL;
2107     }
2108
2109     if (empty($customOptionGroup[$cacheKey])) {
2110       $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2111
2112       //support for single as well as array format.
2113       if (!empty($includeFieldIds)) {
2114         if (is_array($includeFieldIds)) {
2115           $includeFieldIds = implode(',', $includeFieldIds);
2116         }
2117         $whereClause .= "OR f.id IN ( $includeFieldIds )";
2118       }
2119
2120       $query = "
2121     SELECT  g.id, g.title
2122       FROM  civicrm_option_group g
2123 INNER JOIN  civicrm_custom_field f ON ( g.id = f.option_group_id )
2124      WHERE  {$whereClause}";
2125
2126       $dao = CRM_Core_DAO::executeQuery($query);
2127       while ($dao->fetch()) {
2128         $customOptionGroup[$cacheKey][$dao->id] = $dao->title;
2129       }
2130     }
2131
2132     return $customOptionGroup[$cacheKey];
2133   }
2134
2135   /**
2136    * Fix orphan groups.
2137    *
2138    * @param int $customFieldId
2139    *   Custom field id.
2140    * @param int $optionGroupId
2141    *   Option group id.
2142    *
2143    * @return void
2144    */
2145   public static function fixOptionGroups($customFieldId, $optionGroupId) {
2146     // check if option group belongs to any custom Field else delete
2147     // get the current option group
2148     $currentOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
2149       $customFieldId,
2150       'option_group_id'
2151     );
2152     // get the updated option group
2153     // if both are same return
2154     if ($currentOptionGroupId == $optionGroupId) {
2155       return;
2156     }
2157
2158     // check if option group is related to any other field
2159     self::checkOptionGroup($currentOptionGroupId);
2160   }
2161
2162   /**
2163    * Check if option group is related to more than one
2164    * custom field
2165    *
2166    * @param int $optionGroupId
2167    *   Option group id.
2168    *
2169    * @return void
2170    */
2171   public static function checkOptionGroup($optionGroupId) {
2172     $query = "
2173 SELECT count(*)
2174 FROM   civicrm_custom_field
2175 WHERE  option_group_id = {$optionGroupId}";
2176
2177     $count = CRM_Core_DAO::singleValueQuery($query);
2178
2179     if ($count < 2) {
2180       //delete the option group
2181       CRM_Core_BAO_OptionGroup::del($optionGroupId);
2182     }
2183   }
2184
2185   /**
2186    * @param int $optionGroupId
2187    * @param $htmlType
2188    *
2189    * @return null|string
2190    */
2191   public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2192     $query = "
2193 SELECT   default_value, html_type
2194 FROM     civicrm_custom_field
2195 WHERE    option_group_id = {$optionGroupId}
2196 AND      default_value IS NOT NULL
2197 ORDER BY html_type";
2198
2199     $dao = CRM_Core_DAO::executeQuery($query);
2200     $defaultValue = NULL;
2201     $defaultHTMLType = NULL;
2202     while ($dao->fetch()) {
2203       if ($dao->html_type == $htmlType) {
2204         return $dao->default_value;
2205       }
2206       if ($defaultValue == NULL) {
2207         $defaultValue = $dao->default_value;
2208         $defaultHTMLType = $dao->html_type;
2209       }
2210     }
2211
2212     // some conversions are needed if either the old or new has a html type which has potential
2213     // multiple default values.
2214     if (($htmlType == 'CheckBox' || $htmlType == 'Multi-Select') &&
2215       ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2216     ) {
2217       $defaultValue = CRM_Core_DAO::VALUE_SEPARATOR . $defaultValue . CRM_Core_DAO::VALUE_SEPARATOR;
2218     }
2219     elseif (($defaultHTMLType == 'CheckBox' || $defaultHTMLType == 'Multi-Select') &&
2220       ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2221     ) {
2222       $defaultValue = substr($defaultValue, 1, -1);
2223       $values = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2224         substr($defaultValue, 1, -1)
2225       );
2226       $defaultValue = $values[0];
2227     }
2228
2229     return $defaultValue;
2230   }
2231
2232   /**
2233    * @param array $params
2234    * @param $customFields
2235    * @param int $entityID
2236    * @param $customFieldExtends
2237    * @param bool $inline
2238    *
2239    * @return array
2240    */
2241   public static function postProcess(
2242     &$params,
2243     &$customFields,
2244     $entityID,
2245     $customFieldExtends,
2246     $inline = FALSE
2247   ) {
2248     $customData = array();
2249
2250     foreach ($params as $key => $value) {
2251       if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE)) {
2252
2253         // for autocomplete transfer hidden value instead of label
2254         if ($params[$key] && isset($params[$key . '_id'])) {
2255           $value = $params[$key . '_id'];
2256         }
2257
2258         // we need to append time with date
2259         if ($params[$key] && isset($params[$key . '_time'])) {
2260           $value .= ' ' . $params[$key . '_time'];
2261         }
2262
2263         CRM_Core_BAO_CustomField::formatCustomField($customFieldInfo[0],
2264           $customData,
2265           $value,
2266           $customFieldExtends,
2267           $customFieldInfo[1],
2268           $entityID,
2269           $inline
2270         );
2271       }
2272     }
2273     return $customData;
2274   }
2275
2276   /**
2277    * @param $field
2278    * @param $options
2279    *
2280    * @throws Exception
2281    */
2282   public static function buildOption($field, &$options) {
2283     // Fixme - adding anything but options to the $options array is a bad idea
2284     // What if an option had the key 'attributes'?
2285     $options['attributes'] = array(
2286       'label' => $field['label'],
2287       'data_type' => $field['data_type'],
2288       'html_type' => $field['html_type'],
2289     );
2290
2291     $optionGroupID = NULL;
2292     if (($field['html_type'] == 'CheckBox' ||
2293       $field['html_type'] == 'Radio' ||
2294       $field['html_type'] == 'Select' ||
2295       $field['html_type'] == 'AdvMulti-Select' ||
2296       $field['html_type'] == 'Multi-Select' ||
2297       ($field['html_type'] == 'Autocomplete-Select' && $field['data_type'] != 'ContactReference')
2298     )
2299     ) {
2300       if ($field['option_group_id']) {
2301         $optionGroupID = $field['option_group_id'];
2302       }
2303       elseif ($field['data_type'] != 'Boolean') {
2304         CRM_Core_Error::fatal();
2305       }
2306     }
2307
2308     // build the cache for custom values with options (label => value)
2309     if ($optionGroupID != NULL) {
2310       $query = "
2311 SELECT label, value
2312   FROM civicrm_option_value
2313  WHERE option_group_id = $optionGroupID
2314 ";
2315
2316       $dao = CRM_Core_DAO::executeQuery($query);
2317       while ($dao->fetch()) {
2318         if ($field['data_type'] == 'Int' || $field['data_type'] == 'Float') {
2319           $num = round($dao->value, 2);
2320           $options["$num"] = $dao->label;
2321         }
2322         else {
2323           $options[$dao->value] = $dao->label;
2324         }
2325       }
2326
2327       CRM_Utils_Hook::customFieldOptions($field['id'], $options);
2328     }
2329   }
2330
2331   /**
2332    * @param $fieldLabel
2333    * @param null $groupTitle
2334    *
2335    * @return null
2336    */
2337   public static function getCustomFieldID($fieldLabel, $groupTitle = NULL) {
2338     $params = array(1 => array($fieldLabel, 'String'));
2339     if ($groupTitle) {
2340       $params[2] = array($groupTitle, 'String');
2341       $sql = "
2342 SELECT     f.id
2343 FROM       civicrm_custom_field f
2344 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2345 WHERE      ( f.label = %1 OR f.name  = %1 )
2346 AND        ( g.title = %2 OR g.name = %2 )
2347 ";
2348     }
2349     else {
2350       $sql = "
2351 SELECT     f.id
2352 FROM       civicrm_custom_field f
2353 WHERE      ( f.label = %1 OR f.name = %1 )
2354 ";
2355     }
2356
2357     $dao = CRM_Core_DAO::executeQuery($sql, $params);
2358     if ($dao->fetch() &&
2359       $dao->N == 1
2360     ) {
2361       return $dao->id;
2362     }
2363     else {
2364       return NULL;
2365     }
2366   }
2367
2368   /**
2369    * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2370    *
2371    * @param array $ids
2372    *
2373    * @return array
2374    */
2375   public static function getNameFromID($ids) {
2376     if (is_array($ids)) {
2377       $ids = implode(',', $ids);
2378     }
2379     $sql = "
2380 SELECT     f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2381 FROM       civicrm_custom_field f
2382 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2383 WHERE      f.id IN ($ids)";
2384
2385     $dao = CRM_Core_DAO::executeQuery($sql);
2386     $result = array();
2387     while ($dao->fetch()) {
2388       $result[$dao->id] = array(
2389         'field_name' => $dao->field_name,
2390         'field_label' => $dao->field_label,
2391         'group_name' => $dao->group_name,
2392         'group_title' => $dao->group_title,
2393       );
2394     }
2395     return $result;
2396   }
2397
2398   /**
2399    * Validate custom data.
2400    *
2401    * @param array $params
2402    *   Custom data submitted.
2403    *   ie array( 'custom_1' => 'validate me' );
2404    *
2405    * @return array
2406    *   validation errors.
2407    */
2408   public static function validateCustomData($params) {
2409     $errors = array();
2410     if (!is_array($params) || empty($params)) {
2411       return $errors;
2412     }
2413
2414     //pick up profile fields.
2415     $profileFields = array();
2416     $ufGroupId = CRM_Utils_Array::value('ufGroupId', $params);
2417     if ($ufGroupId) {
2418       $profileFields = CRM_Core_BAO_UFGroup::getFields($ufGroupId,
2419         FALSE,
2420         CRM_Core_Action::VIEW
2421       );
2422     }
2423
2424     //lets start w/ params.
2425     foreach ($params as $key => $value) {
2426       $customFieldID = self::getKeyID($key);
2427       if (!$customFieldID) {
2428         continue;
2429       }
2430
2431       //load the structural info for given field.
2432       $field = new CRM_Core_DAO_CustomField();
2433       $field->id = $customFieldID;
2434       if (!$field->find(TRUE)) {
2435         continue;
2436       }
2437       $dataType = $field->data_type;
2438
2439       $profileField = CRM_Utils_Array::value($key, $profileFields, array());
2440       $fieldTitle = CRM_Utils_Array::value('title', $profileField);
2441       $isRequired = CRM_Utils_Array::value('is_required', $profileField);
2442       if (!$fieldTitle) {
2443         $fieldTitle = $field->label;
2444       }
2445
2446       //no need to validate.
2447       if (CRM_Utils_System::isNull($value) && !$isRequired) {
2448         continue;
2449       }
2450
2451       //lets validate first for required field.
2452       if ($isRequired && CRM_Utils_System::isNull($value)) {
2453         $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2454         continue;
2455       }
2456
2457       //now time to take care of custom field form rules.
2458       $ruleName = $errorMsg = NULL;
2459       switch ($dataType) {
2460         case 'Int':
2461           $ruleName = 'integer';
2462           $errorMsg = ts('%1 must be an integer (whole number).',
2463             array(1 => $fieldTitle)
2464           );
2465           break;
2466
2467         case 'Money':
2468           $ruleName = 'money';
2469           $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2470             array(1 => $fieldTitle)
2471           );
2472           break;
2473
2474         case 'Float':
2475           $ruleName = 'numeric';
2476           $errorMsg = ts('%1 must be a number (with or without decimal point).',
2477             array(1 => $fieldTitle)
2478           );
2479           break;
2480
2481         case 'Link':
2482           $ruleName = 'wikiURL';
2483           $errorMsg = ts('%1 must be valid Website.',
2484             array(1 => $fieldTitle)
2485           );
2486           break;
2487       }
2488
2489       if ($ruleName && !CRM_Utils_System::isNull($value)) {
2490         $valid = FALSE;
2491         $funName = "CRM_Utils_Rule::{$ruleName}";
2492         if (is_callable($funName)) {
2493           $valid = call_user_func($funName, $value);
2494         }
2495         if (!$valid) {
2496           $errors[$key] = $errorMsg;
2497         }
2498       }
2499     }
2500
2501     return $errors;
2502   }
2503
2504   /**
2505    * @param int $customId
2506    *
2507    * @return bool
2508    */
2509   public static function isMultiRecordField($customId) {
2510     $isMultipleWithGid = FALSE;
2511     if (!is_numeric($customId)) {
2512       $customId = self::getKeyID($customId);
2513     }
2514     if (is_numeric($customId)) {
2515       $sql = "SELECT cg.id cgId
2516  FROM civicrm_custom_group cg
2517  INNER JOIN civicrm_custom_field cf
2518  ON cg.id = cf.custom_group_id
2519 WHERE cf.id = %1 AND cg.is_multiple = 1";
2520       $params[1] = array($customId, 'Integer');
2521       $dao = CRM_Core_DAO::executeQuery($sql, $params);
2522       if ($dao->fetch()) {
2523         if ($dao->cgId) {
2524           $isMultipleWithGid = $dao->cgId;
2525         }
2526       }
2527     }
2528
2529     return $isMultipleWithGid;
2530   }
2531
2532   /**
2533    * Does this field store a serialized string?
2534    * @param CRM_Core_DAO_CustomField|array $field
2535    * @return bool
2536    */
2537   public static function isSerialized($field) {
2538     // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2539     $field = (array) $field;
2540     // 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.
2541     return ($field['html_type'] == 'CheckBox' || strpos($field['html_type'], 'Multi') !== FALSE);
2542   }
2543
2544   /**
2545    * @param array $field
2546    * @param string|null $optionGroupName
2547    */
2548   private static function getOptionsForField(&$field, $optionGroupName) {
2549     if ($optionGroupName) {
2550       $field['pseudoconstant'] = array(
2551         'optionGroupName' => $optionGroupName,
2552         'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2553       );
2554     }
2555     elseif ($field['data_type'] == 'Boolean') {
2556       $field['pseudoconstant'] = array(
2557         'callback' => 'CRM_Core_SelectValues::boolean',
2558       );
2559     }
2560     elseif ($field['data_type'] == 'Country') {
2561       $field['pseudoconstant'] = array(
2562         'table' => 'civicrm_country',
2563         'keyColumn' => 'id',
2564         'labelColumn' => 'name',
2565         'nameColumn' => 'iso_code',
2566       );
2567     }
2568     elseif ($field['data_type'] == 'StateProvince') {
2569       $field['pseudoconstant'] = array(
2570         'table' => 'civicrm_state_province',
2571         'keyColumn' => 'id',
2572         'labelColumn' => 'name',
2573       );
2574     }
2575   }
2576
2577 }