CRM/Core/BAO/CustomField.php

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