CRM/Custom/Form/Field.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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  * form to process actions on the field aspect of Custom
  38  */
  39 class CRM_Custom_Form_Field extends CRM_Core_Form {
  40
  41   /**
  42    * Constants for number of options for data types of multiple option.
  43    */
  44   CONST NUM_OPTION = 11;
  45
  46   /**
  47    * the custom group id saved to the session for an update
  48    *
  49    * @var int
  50    * @access protected
  51    */
  52   protected $_gid;
  53
  54   /**
  55    * The field id, used when editing the field
  56    *
  57    * @var int
  58    * @access protected
  59    */
  60   protected $_id;
  61
  62   /**
  63    * The default custom data/input types, when editing the field
  64    *
  65    * @var array
  66    * @access protected
  67    */
  68   protected $_defaultDataType;
  69
  70   /**
  71    * array of custom field values if update mode
  72    */
  73   protected $_values;
  74
  75   /**
  76    * Array for valid combinations of data_type & html_type
  77    *
  78    * @var array
  79    * @static
  80    */
  81   private static $_dataTypeValues = NULL;
  82   private static $_dataTypeKeys = NULL;
  83
  84   private static $_dataToHTML = NULL;
  85
  86   private static $_dataToLabels = NULL;
  87
  88   /**
  89    * Function to set variables up before form is built
  90    *
  91    * @param null
  92    *
  93    * @return void
  94    * @access public
  95    */
  96   public function preProcess() {
  97     if (!(self::$_dataTypeKeys)) {
  98       self::$_dataTypeKeys = array_keys(CRM_Core_BAO_CustomField::dataType());
  99       self::$_dataTypeValues = array_values(CRM_Core_BAO_CustomField::dataType());
 100     }
 101
 102     if (!self::$_dataToHTML) {
 103       self::$_dataToHTML = CRM_Core_BAO_CustomField::dataToHtml();
 104     }
 105
 106     //custom field id
 107     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 108
 109     $this->_values = array();
 110     //get the values form db if update.
 111     if ($this->_id) {
 112       $params = array('id' => $this->_id);
 113       CRM_Core_BAO_CustomField::retrieve($params, $this->_values);
 114       // note_length is an alias for the text_length field
 115       $this->_values['note_length'] = CRM_Utils_Array::value('text_length', $this->_values);
 116       // custom group id
 117       $this->_gid = $this->_values['custom_group_id'];
 118     }
 119     else {
 120       // custom group id
 121       $this->_gid = CRM_Utils_Request::retrieve('gid', 'Positive', $this);
 122     }
 123
 124     if ($isReserved = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid, 'is_reserved', 'id')) {
 125       CRM_Core_Error::fatal("You cannot add or edit fields in a reserved custom field-set.");
 126     }
 127
 128     if ($this->_gid) {
 129       $url = CRM_Utils_System::url('civicrm/admin/custom/group/field',
 130         "reset=1&action=browse&gid={$this->_gid}"
 131       );
 132
 133       $session = CRM_Core_Session::singleton();
 134       $session->pushUserContext($url);
 135     }
 136
 137     if (self::$_dataToLabels == NULL) {
 138       self::$_dataToLabels = array(
 139         array('Text' => ts('Text'), 'Select' => ts('Select'),
 140           'Radio' => ts('Radio'), 'CheckBox' => ts('CheckBox'), 'Multi-Select' => ts('Multi-Select'),
 141           'AdvMulti-Select' => ts('Advanced Multi-Select'),
 142           'Autocomplete-Select' => ts('Autocomplete Select'),
 143         ),
 144         array('Text' => ts('Text'), 'Select' => ts('Select'),
 145           'Radio' => ts('Radio'),
 146         ),
 147         array('Text' => ts('Text'), 'Select' => ts('Select'),
 148           'Radio' => ts('Radio'),
 149         ),
 150         array('Text' => ts('Text'), 'Select' => ts('Select'),
 151           'Radio' => ts('Radio'),
 152         ),
 153         array('TextArea' => ts('TextArea'), 'RichTextEditor' => 'RichTextEditor'),
 154         array('Date' => ts('Select Date')),
 155         array('Radio' => ts('Radio')),
 156         array('StateProvince' => ts('Select State/Province'), 'Multi-Select' => ts('Multi-Select State/Province')),
 157         array('Country' => ts('Select Country'), 'Multi-Select' => ts('Multi-Select Country ')),
 158         array('File' => ts('Select File')),
 159         array('Link' => ts('Link')),
 160         array('ContactReference' => ts('Autocomplete Select')),
 161       );
 162     }
 163   }
 164
 165   /**
 166    * This function sets the default values for the form. Note that in edit/view mode
 167    * the default values are retrieved from the database
 168    *
 169    * @param null
 170    *
 171    * @return array    array of default values
 172    * @access public
 173    */
 174   function setDefaultValues() {
 175     $defaults = $this->_values;
 176
 177     if ($this->_id) {
 178       $this->assign('id', $this->_id);
 179       $this->_gid = $defaults['custom_group_id'];
 180
 181       //get the value for state or country
 182       if ($defaults['data_type'] == 'StateProvince' &&
 183         $stateId = CRM_Utils_Array::value('default_value', $defaults)
 184       ) {
 185         $defaults['default_value'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_StateProvince', $stateId);
 186       }
 187       elseif ($defaults['data_type'] == 'Country' &&
 188         $countryId = CRM_Utils_Array::value('default_value', $defaults)
 189       ) {
 190         $defaults['default_value'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Country', $countryId);
 191       }
 192
 193       if ($defaults['data_type'] == 'ContactReference' && !empty($defaults['filter'])) {
 194         $contactRefFilter = 'Advance';
 195         if (strpos($defaults['filter'], 'action=lookup') !== FALSE &&
 196           strpos($defaults['filter'], 'group=') !== FALSE
 197         ) {
 198           $filterParts = explode('&', $defaults['filter']);
 199
 200           if (count($filterParts) == 2) {
 201             $contactRefFilter = 'Group';
 202             foreach ($filterParts as $part) {
 203               if (strpos($part, 'group=') === FALSE) {
 204                 continue;
 205               }
 206               $groups = substr($part, strpos($part, '=') + 1);
 207               foreach (explode(',', $groups) as $grp) {
 208                 if (CRM_Utils_Rule::positiveInteger($grp)) {
 209                   $defaults['group_id'][] = $grp;
 210                 }
 211               }
 212             }
 213           }
 214         }
 215         $defaults['filter_selected'] = $contactRefFilter;
 216       }
 217
 218       if (!empty($defaults['data_type'])) {
 219         $defaultDataType = array_search($defaults['data_type'],
 220           self::$_dataTypeKeys
 221         );
 222         $defaultHTMLType = array_search($defaults['html_type'],
 223           self::$_dataToHTML[$defaultDataType]
 224         );
 225         $defaults['data_type'] = array(
 226           '0' => $defaultDataType,
 227           '1' => $defaultHTMLType,
 228         );
 229         $this->_defaultDataType = $defaults['data_type'];
 230       }
 231
 232       $defaults['option_type'] = 2;
 233
 234       $this->assign('changeFieldType', CRM_Custom_Form_ChangeFieldType::fieldTypeTransitions($this->_values['data_type'], $this->_values['html_type']));
 235     }
 236     else {
 237       $defaults['is_active'] = 1;
 238       $defaults['option_type'] = 1;
 239     }
 240
 241     // set defaults for weight.
 242     for ($i = 1; $i <= self::NUM_OPTION; $i++) {
 243       $defaults['option_status[' . $i . ']'] = 1;
 244       $defaults['option_weight[' . $i . ']'] = $i;
 245     }
 246
 247     if ($this->_action & CRM_Core_Action::ADD) {
 248       $fieldValues = array('custom_group_id' => $this->_gid);
 249       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_CustomField', $fieldValues);
 250
 251       $defaults['text_length'] = 255;
 252       $defaults['note_columns'] = 60;
 253       $defaults['note_rows'] = 4;
 254       $defaults['is_view'] = 0;
 255     }
 256
 257     if (!empty($defaults['html_type'])) {
 258       $dontShowLink = substr($defaults['html_type'], -14) == 'State/Province' || substr($defaults['html_type'], -7) == 'Country' ? 1 : 0;
 259     }
 260
 261     if (isset($dontShowLink)) {
 262       $this->assign('dontShowLink', $dontShowLink);
 263     }
 264     if ($this->_action & CRM_Core_Action::ADD &&
 265       CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid, 'is_multiple', 'id')) {
 266       $defaults['in_selector'] = 1;
 267     }
 268
 269     return $defaults;
 270   }
 271
 272   /**
 273    * Function to actually build the form
 274    *
 275    * @param null
 276    *
 277    * @return void
 278    * @access public
 279    */
 280   public function buildQuickForm() {
 281     if ($this->_gid) {
 282       $this->_title = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid, 'title');
 283       CRM_Utils_System::setTitle($this->_title . ' - ' . ($this->_id ? ts('Edit Field') : ts('New Field')));
 284       $this->assign('gid', $this->_gid);
 285     }
 286
 287     // lets trim all the whitespace
 288     $this->applyFilter('__ALL__', 'trim');
 289
 290     $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_CustomField');
 291
 292     // label
 293     $this->add('text',
 294       'label',
 295       ts('Field Label'),
 296       $attributes['label'],
 297       TRUE
 298     );
 299
 300     $dt = &self::$_dataTypeValues;
 301     $it = array();
 302     foreach ($dt as $key => $value) {
 303       $it[$key] = self::$_dataToLabels[$key];
 304     }
 305     $sel = &$this->addElement('hierselect',
 306       'data_type',
 307       ts('Data and Input Field Type'),
 308       'onclick="clearSearchBoxes();custom_option_html_type(this.form)"; onBlur="custom_option_html_type(this.form)";',
 309       '&nbsp;&nbsp;&nbsp;'
 310     );
 311     $sel->setOptions(array($dt, $it));
 312
 313     if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_gid, 'is_multiple')) {
 314       $this->add('checkbox', 'in_selector', ts('Display in Table?'));
 315     }
 316
 317     if ($this->_action == CRM_Core_Action::UPDATE) {
 318       $this->freeze('data_type');
 319     }
 320     $includeFieldIds = NULL;
 321     if ($this->_action == CRM_Core_Action::UPDATE) {
 322       $includeFieldIds = $this->_values['id'];
 323     }
 324     $optionGroups = CRM_Core_BAO_CustomField::customOptionGroup($includeFieldIds);
 325     $emptyOptGroup = FALSE;
 326     if (empty($optionGroups)) {
 327       $emptyOptGroup = TRUE;
 328       $optionTypes = array('1' => ts('Create a new set of options'));
 329     }
 330     else {
 331       $optionTypes = array('1' => ts('Create a new set of options'),
 332         '2' => ts('Reuse an existing set'),
 333       );
 334
 335       $this->add('select',
 336         'option_group_id',
 337         ts('Multiple Choice Option Sets'),
 338         array(
 339           '' => ts('- select -')) + $optionGroups
 340       );
 341     }
 342
 343     $element = &$this->addRadio('option_type',
 344       ts('Option Type'),
 345       $optionTypes,
 346       array(
 347         'onclick' => "showOptionSelect();"), '<br/>'
 348     );
 349
 350
 351     $contactGroups = CRM_Core_PseudoConstant::group();
 352     asort($contactGroups);
 353
 354     $this->add('select',
 355       'group_id',
 356       ts('Limit List to Group'),
 357       $contactGroups,
 358       FALSE,
 359       array('multiple' => 'multiple')
 360     );
 361
 362     $this->add('text',
 363       'filter',
 364       ts('Advanced Filter'),
 365       $attributes['filter']
 366     );
 367
 368     $this->add('hidden', 'filter_selected', 'Group', array('id' => 'filter_selected'));
 369
 370     //if empty option group freeze the option type.
 371     if ($emptyOptGroup) {
 372       $element->freeze();
 373     }
 374
 375     // form fields of Custom Option rows
 376     $defaultOption = array();
 377     $_showHide = new CRM_Core_ShowHideBlocks('', '');
 378     for ($i = 1; $i <= self::NUM_OPTION; $i++) {
 379
 380       //the show hide blocks
 381       $showBlocks = 'optionField_' . $i;
 382       if ($i > 2) {
 383         $_showHide->addHide($showBlocks);
 384         if ($i == self::NUM_OPTION) {
 385           $_showHide->addHide('additionalOption');
 386         }
 387       }
 388       else {
 389         $_showHide->addShow($showBlocks);
 390       }
 391
 392       $optionAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue');
 393       // label
 394       $this->add('text', 'option_label[' . $i . ']', ts('Label'),
 395         $optionAttributes['label']
 396       );
 397
 398       // value
 399       $this->add('text', 'option_value[' . $i . ']', ts('Value'),
 400         $optionAttributes['value']
 401       );
 402
 403       // weight
 404       $this->add('text', "option_weight[$i]", ts('Order'),
 405         $optionAttributes['weight']
 406       );
 407
 408       // is active ?
 409       $this->add('checkbox', "option_status[$i]", ts('Active?'));
 410
 411       $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
 412
 413       //for checkbox handling of default option
 414       $this->add('checkbox', "default_checkbox_option[$i]", NULL);
 415     }
 416
 417     //default option selection
 418     $this->addGroup($defaultOption, 'default_option');
 419
 420     $_showHide->addToTemplate();
 421
 422     // text length for alpha numeric data types
 423     $this->add('text',
 424       'text_length',
 425       ts('Database field length'),
 426       $attributes['text_length'],
 427       FALSE
 428     );
 429     $this->addRule('text_length', ts('Value should be a positive number'), 'integer');
 430
 431     $this->add('text',
 432       'start_date_years',
 433       ts('Dates may be up to'),
 434       $attributes['start_date_years'],
 435       FALSE
 436     );
 437     $this->add('text',
 438       'end_date_years',
 439       ts('Dates may be up to'),
 440       $attributes['end_date_years'],
 441       FALSE
 442     );
 443
 444     $this->addRule('start_date_years', ts('Value should be a positive number'), 'integer');
 445     $this->addRule('end_date_years', ts('Value should be a positive number'), 'integer');
 446
 447     $this->add('select', 'date_format', ts('Date Format'),
 448       array('' => ts('- select -')) + CRM_Core_SelectValues::getDatePluginInputFormats()
 449     );
 450
 451     $this->add('select', 'time_format', ts('Time'),
 452       array('' => ts('- none -')) + CRM_Core_SelectValues::getTimeFormats()
 453     );
 454
 455     // for Note field
 456     $this->add('text',
 457       'note_columns',
 458       ts('Width (columns)') . ' ',
 459       $attributes['note_columns'],
 460       FALSE
 461     );
 462     $this->add('text',
 463       'note_rows',
 464       ts('Height (rows)') . ' ',
 465       $attributes['note_rows'],
 466       FALSE
 467     );
 468     $this->add('text',
 469       'note_length',
 470       ts('Maximum length') . ' ',
 471       $attributes['text_length'], // note_length is an alias for the text-length field
 472       FALSE
 473     );
 474
 475     $this->addRule('note_columns', ts('Value should be a positive number'), 'positiveInteger');
 476     $this->addRule('note_rows', ts('Value should be a positive number'), 'positiveInteger');
 477     $this->addRule('note_length', ts('Value should be a positive number'), 'positiveInteger');
 478
 479     // weight
 480     $this->add('text', 'weight', ts('Order'),
 481       $attributes['weight'],
 482       TRUE
 483     );
 484     $this->addRule('weight', ts('is a numeric field'), 'numeric');
 485
 486     // is required ?
 487     $this->add('checkbox', 'is_required', ts('Required?'));
 488
 489     // checkbox / radio options per line
 490     $this->add('text', 'options_per_line', ts('Options Per Line'));
 491     $this->addRule('options_per_line', ts('must be a numeric value'), 'numeric');
 492
 493     // default value, help pre, help post, mask, attributes, javascript ?
 494     $this->add('text', 'default_value', ts('Default Value'),
 495       $attributes['default_value']
 496     );
 497     $this->add('textarea', 'help_pre', ts('Field Pre Help'),
 498       $attributes['help_pre']
 499     );
 500     $this->add('textarea', 'help_post', ts('Field Post Help'),
 501       $attributes['help_post']
 502     );
 503     $this->add('text', 'mask', ts('Mask'),
 504       $attributes['mask']
 505     );
 506
 507     // is active ?
 508     $this->add('checkbox', 'is_active', ts('Active?'));
 509
 510     // is active ?
 511     $this->add('checkbox', 'is_view', ts('View Only?'));
 512
 513     // is searchable ?
 514     $this->addElement('checkbox',
 515       'is_searchable',
 516       ts('Is this Field Searchable?'),
 517       NULL, array('onclick' => "showSearchRange(this)")
 518     );
 519
 520     // is searchable by range?
 521     $searchRange   = array();
 522     $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
 523     $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
 524
 525     $this->addGroup($searchRange, 'is_search_range', ts('Search by Range?'));
 526
 527     // add buttons
 528     $this->addButtons(array(
 529         array(
 530           'type' => 'done',
 531           'name' => ts('Save'),
 532           'isDefault' => TRUE,
 533         ),
 534         array(
 535           'type' => 'next',
 536           'name' => ts('Save and New'),
 537           'subName' => 'new',
 538         ),
 539         array(
 540           'type' => 'cancel',
 541           'name' => ts('Cancel'),
 542         ),
 543       )
 544     );
 545
 546     // add a form rule to check default value
 547     $this->addFormRule(array('CRM_Custom_Form_Field', 'formRule'), $this);
 548
 549     // if view mode pls freeze it with the done button.
 550     if ($this->_action & CRM_Core_Action::VIEW) {
 551       $this->freeze();
 552       $url = CRM_Utils_System::url('civicrm/admin/custom/group/field', 'reset=1&action=browse&gid=' . $this->_gid);
 553       $this->addElement('button',
 554         'done',
 555         ts('Done'),
 556         array('onclick' => "location.href='$url'")
 557       );
 558     }
 559   }
 560
 561   /**
 562    * global validation rules for the form
 563    *
 564    * @param array $fields posted values of the form
 565    *
 566    * @param $files
 567    * @param $self
 568    *
 569    * @return array    if errors then list of errors to be posted back to the form,
 570    *                  true otherwise
 571    * @static
 572    * @access public
 573    */
 574   static function formRule($fields, $files, $self) {
 575     $default = CRM_Utils_Array::value('default_value', $fields);
 576
 577     $errors = array();
 578
 579     //validate field label as well as name.
 580     $title  = $fields['label'];
 581     $name   = CRM_Utils_String::munge($title, '_', 64);
 582     $gId    = $self->_gid;  // CRM-7564
 583     $query  = 'select count(*) from civicrm_custom_field where ( name like %1 OR label like %2 ) and id != %3 and custom_group_id = %4';
 584     $fldCnt = CRM_Core_DAO::singleValueQuery($query, array(1 => array($name, 'String'),
 585         2 => array($title, 'String'),
 586         3 => array((int)$self->_id, 'Integer'),
 587         4 => array($gId, 'Integer'),
 588       ));
 589     if ($fldCnt) {
 590       $errors['label'] = ts('Custom field \'%1\' already exists in Database.', array(1 => $title));
 591     }
 592
 593     //checks the given custom field name doesnot start with digit
 594     if (!empty($title)) {
 595       // gives the ascii value
 596       $asciiValue = ord($title{0});
 597       if ($asciiValue >= 48 && $asciiValue <= 57) {
 598         $errors['label'] = ts("Field's Name should not start with digit");
 599       }
 600     }
 601
 602     // ensure that the label is not 'id'
 603     if (strtolower($title) == 'id') {
 604       $errors['label'] = ts("You cannot use 'id' as a field label.");
 605     }
 606
 607     if (!isset($fields['data_type'][0]) || !isset($fields['data_type'][1])) {
 608       $errors['_qf_default'] = ts('Please enter valid - Data and Input Field Type.');
 609     }
 610
 611     $dataType = self::$_dataTypeKeys[$fields['data_type'][0]];
 612
 613     if ($default || $dataType == 'ContactReference') {
 614       switch ($dataType) {
 615         case 'Int':
 616           if (!CRM_Utils_Rule::integer($default)) {
 617             $errors['default_value'] = ts('Please enter a valid integer as default value.');
 618           }
 619           break;
 620
 621         case 'Float':
 622           if (!CRM_Utils_Rule::numeric($default)) {
 623             $errors['default_value'] = ts('Please enter a valid number as default value.');
 624           }
 625           break;
 626
 627         case 'Money':
 628           if (!CRM_Utils_Rule::money($default)) {
 629             $errors['default_value'] = ts('Please enter a valid number value.');
 630           }
 631           break;
 632
 633         case 'Link':
 634           if (!CRM_Utils_Rule::url($default)) {
 635             $errors['default_value'] = ts('Please enter a valid link.');
 636           }
 637           break;
 638
 639         case 'Date':
 640           if (!CRM_Utils_Rule::date($default)) {
 641             $errors['default_value'] = ts('Please enter a valid date as default value using YYYY-MM-DD format. Example: 2004-12-31.');
 642           }
 643           break;
 644
 645         case 'Boolean':
 646           if ($default != '1' && $default != '0') {
 647             $errors['default_value'] = ts('Please enter 1 (for Yes) or 0 (for No) if you want to set a default value.');
 648           }
 649           break;
 650
 651         case 'Country':
 652           if (!empty($default)) {
 653             $query = "SELECT count(*) FROM civicrm_country WHERE name = %1 OR iso_code = %1";
 654             $params = array(1 => array($fields['default_value'], 'String'));
 655             if (CRM_Core_DAO::singleValueQuery($query, $params) <= 0) {
 656               $errors['default_value'] = ts('Invalid default value for country.');
 657             }
 658           }
 659           break;
 660
 661         case 'StateProvince':
 662           if (!empty($default)) {
 663             $query = "
 664 SELECT count(*)
 665   FROM civicrm_state_province
 666  WHERE name = %1
 667     OR abbreviation = %1";
 668             $params = array(1 => array($fields['default_value'], 'String'));
 669             if (CRM_Core_DAO::singleValueQuery($query, $params) <= 0) {
 670               $errors['default_value'] = ts('The invalid default value for State/Province data type');
 671             }
 672           }
 673           break;
 674
 675         case 'ContactReference':
 676           if ($fields['filter_selected'] == 'Advance' && !empty($fields['filter'])) {
 677             if (strpos($fields['filter'], 'entity=') !== FALSE) {
 678               $errors['filter'] = ts("Please do not include entity parameter (entity is always 'contact')");
 679             }
 680             elseif (strpos($fields['filter'], 'action=get') === FALSE) {
 681               $errors['filter'] = ts("Only 'get' action is supported.");
 682             }
 683           }
 684           $self->setDefaults(array('filter_selected', $fields['filter_selected']));
 685           break;
 686       }
 687     }
 688
 689     if (self::$_dataTypeKeys[$fields['data_type'][0]] == 'Date') {
 690       if (!$fields['date_format']) {
 691         $errors['date_format'] = ts('Please select a date format.');
 692       }
 693     }
 694
 695     /** Check the option values entered
 696      *  Appropriate values are required for the selected datatype
 697      *  Incomplete row checking is also required.
 698      */
 699     $_flagOption = $_rowError = 0;
 700     $_showHide   = new CRM_Core_ShowHideBlocks('', '');
 701     $dataType    = self::$_dataTypeKeys[$fields['data_type'][0]];
 702     if (isset($fields['data_type'][1])) {
 703       $dataField = $fields['data_type'][1];
 704     }
 705     $optionFields = array('Select', 'Multi-Select', 'CheckBox', 'Radio', 'AdvMulti-Select');
 706
 707     if (isset($fields['option_type']) && $fields['option_type'] == 1) {
 708       //capture duplicate Custom option values
 709       if (!empty($fields['option_value'])) {
 710         $countValue = count($fields['option_value']);
 711         $uniqueCount = count(array_unique($fields['option_value']));
 712
 713         if ($countValue > $uniqueCount) {
 714
 715           $start = 1;
 716           while ($start < self::NUM_OPTION) {
 717             $nextIndex = $start + 1;
 718             while ($nextIndex <= self::NUM_OPTION) {
 719               if ($fields['option_value'][$start] == $fields['option_value'][$nextIndex] &&
 720                 !empty($fields['option_value'][$nextIndex])
 721               ) {
 722                 $errors['option_value[' . $start . ']'] = ts('Duplicate Option values');
 723                 $errors['option_value[' . $nextIndex . ']'] = ts('Duplicate Option values');
 724                 $_flagOption = 1;
 725               }
 726               $nextIndex++;
 727             }
 728             $start++;
 729           }
 730         }
 731       }
 732
 733       //capture duplicate Custom Option label
 734       if (!empty($fields['option_label'])) {
 735         $countValue = count($fields['option_label']);
 736         $uniqueCount = count(array_unique($fields['option_label']));
 737
 738         if ($countValue > $uniqueCount) {
 739           $start = 1;
 740           while ($start < self::NUM_OPTION) {
 741             $nextIndex = $start + 1;
 742             while ($nextIndex <= self::NUM_OPTION) {
 743               if ($fields['option_label'][$start] == $fields['option_label'][$nextIndex] &&
 744                 !empty($fields['option_label'][$nextIndex])
 745               ) {
 746                 $errors['option_label[' . $start . ']'] = ts('Duplicate Option label');
 747                 $errors['option_label[' . $nextIndex . ']'] = ts('Duplicate Option label');
 748                 $_flagOption = 1;
 749               }
 750               $nextIndex++;
 751             }
 752             $start++;
 753           }
 754         }
 755       }
 756
 757       for ($i = 1; $i <= self::NUM_OPTION; $i++) {
 758         if (!$fields['option_label'][$i]) {
 759           if ($fields['option_value'][$i]) {
 760             $errors['option_label[' . $i . ']'] = ts('Option label cannot be empty');
 761             $_flagOption = 1;
 762           }
 763           else {
 764             $_emptyRow = 1;
 765           }
 766         }
 767         else {
 768           if (!strlen(trim($fields['option_value'][$i]))) {
 769             if (!$fields['option_value'][$i]) {
 770               $errors['option_value[' . $i . ']'] = ts('Option value cannot be empty');
 771               $_flagOption = 1;
 772             }
 773           }
 774         }
 775
 776         if ($fields['option_value'][$i] && $dataType != 'String') {
 777           if ($dataType == 'Int') {
 778             if (!CRM_Utils_Rule::integer($fields['option_value'][$i])) {
 779               $_flagOption = 1;
 780               $errors['option_value[' . $i . ']'] = ts('Please enter a valid integer.');
 781             }
 782           }
 783           elseif ($dataType == 'Money') {
 784             if (!CRM_Utils_Rule::money($fields['option_value'][$i])) {
 785               $_flagOption = 1;
 786               $errors['option_value[' . $i . ']'] = ts('Please enter a valid money value.');
 787             }
 788           }
 789           else {
 790             if (!CRM_Utils_Rule::numeric($fields['option_value'][$i])) {
 791               $_flagOption = 1;
 792               $errors['option_value[' . $i . ']'] = ts('Please enter a valid number.');
 793             }
 794           }
 795         }
 796
 797         $showBlocks = 'optionField_' . $i;
 798         if ($_flagOption) {
 799           $_showHide->addShow($showBlocks);
 800           $_rowError = 1;
 801         }
 802
 803         if (!empty($_emptyRow)) {
 804           $_showHide->addHide($showBlocks);
 805         }
 806         else {
 807           $_showHide->addShow($showBlocks);
 808         }
 809         if ($i == self::NUM_OPTION) {
 810           $hideBlock = 'additionalOption';
 811           $_showHide->addHide($hideBlock);
 812         }
 813
 814         $_flagOption = $_emptyRow = 0;
 815       }
 816     }
 817     elseif (isset($dataField) &&
 818       in_array($dataField, $optionFields) &&
 819       !in_array($dataType, array('Boolean', 'Country', 'StateProvince'))
 820     ) {
 821       if (!$fields['option_group_id']) {
 822         $errors['option_group_id'] = ts('You must select a Multiple Choice Option set if you chose Reuse an existing set.');
 823       }
 824       else {
 825         $query = "
 826 SELECT count(*)
 827 FROM   civicrm_custom_field
 828 WHERE  data_type != %1
 829 AND    option_group_id = %2";
 830         $params = array(
 831           1 => array(self::$_dataTypeKeys[$fields['data_type'][0]],
 832             'String',
 833           ),
 834           2 => array($fields['option_group_id'], 'Integer'),
 835         );
 836         $count = CRM_Core_DAO::singleValueQuery($query, $params);
 837         if ($count > 0) {
 838           $errors['option_group_id'] = ts('The data type of the multiple choice option set you\'ve selected does not match the data type assigned to this field.');
 839         }
 840       }
 841     }
 842
 843     $assignError = new CRM_Core_Page();
 844     if ($_rowError) {
 845       $_showHide->addToTemplate();
 846       $assignError->assign('optionRowError', $_rowError);
 847     }
 848     else {
 849       if (isset($fields['data_type'][1])) {
 850         switch (self::$_dataToHTML[$fields['data_type'][0]][$fields['data_type'][1]]) {
 851           case 'Radio':
 852             $_fieldError = 1;
 853             $assignError->assign('fieldError', $_fieldError);
 854             break;
 855
 856           case 'Checkbox':
 857             $_fieldError = 1;
 858             $assignError->assign('fieldError', $_fieldError);
 859             break;
 860
 861           case 'Select':
 862             $_fieldError = 1;
 863             $assignError->assign('fieldError', $_fieldError);
 864             break;
 865
 866           default:
 867             $_fieldError = 0;
 868             $assignError->assign('fieldError', $_fieldError);
 869         }
 870       }
 871
 872       for ($idx = 1; $idx <= self::NUM_OPTION; $idx++) {
 873         $showBlocks = 'optionField_' . $idx;
 874         if (!empty($fields['option_label'][$idx])) {
 875           $_showHide->addShow($showBlocks);
 876         }
 877         else {
 878           $_showHide->addHide($showBlocks);
 879         }
 880       }
 881       $_showHide->addToTemplate();
 882     }
 883
 884     // we can not set require and view at the same time.
 885     if (!empty($fields['is_required']) && !empty($fields['is_view'])) {
 886       $errors['is_view'] = ts('Can not set this field Required and View Only at the same time.');
 887     }
 888
 889     return empty($errors) ? TRUE : $errors;
 890   }
 891
 892   /**
 893    * Process the form
 894    *
 895    * @param null
 896    *
 897    * @return void
 898    * @access public
 899    */
 900   public function postProcess() {
 901     // store the submitted values in an array
 902     $params = $this->controller->exportValues($this->_name);
 903     if ($this->_action == CRM_Core_Action::UPDATE) {
 904       $dataTypeKey         = $this->_defaultDataType[0];
 905       $params['data_type'] = self::$_dataTypeKeys[$this->_defaultDataType[0]];
 906       $params['html_type'] = self::$_dataToHTML[$this->_defaultDataType[0]][$this->_defaultDataType[1]];
 907     }
 908     else {
 909       $dataTypeKey         = $params['data_type'][0];
 910       $params['html_type'] = self::$_dataToHTML[$params['data_type'][0]][$params['data_type'][1]];
 911       $params['data_type'] = self::$_dataTypeKeys[$params['data_type'][0]];
 912     }
 913
 914     //fix for 'is_search_range' field.
 915     if (in_array($dataTypeKey, array(
 916       1, 2, 3, 5))) {
 917       if (empty($params['is_searchable'])) {
 918         $params['is_search_range'] = 0;
 919       }
 920     }
 921     else {
 922       $params['is_search_range'] = 0;
 923     }
 924
 925     $filter = 'null';
 926     if ($dataTypeKey == 11 && !empty($params['filter_selected'])) {
 927       if ($params['filter_selected'] == 'Advance' && trim(CRM_Utils_Array::value('filter', $params))) {
 928         $filter = trim($params['filter']);
 929       }
 930       elseif ($params['filter_selected'] == 'Group' && !empty($params['group_id'])) {
 931
 932         $filter = 'action=lookup&group=' . implode(',', $params['group_id']);
 933       }
 934     }
 935     $params['filter'] = $filter;
 936
 937     // fix for CRM-316
 938     $oldWeight = NULL;
 939     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 940       $fieldValues = array('custom_group_id' => $this->_gid);
 941       if ($this->_id) {
 942         $oldWeight = $this->_values['weight'];
 943       }
 944       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_CustomField', $oldWeight, $params['weight'], $fieldValues);
 945     }
 946
 947     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 948
 949     //store the primary key for State/Province or Country as default value.
 950     if (strlen(trim($params['default_value']))) {
 951       switch ($params['data_type']) {
 952         case 'StateProvince':
 953           $fieldStateProvince = $strtolower($params['default_value']);
 954           $query = "
 955 SELECT id
 956   FROM civicrm_state_province
 957  WHERE LOWER(name) = '$fieldStateProvince'
 958     OR abbreviation = '$fieldStateProvince'";
 959           $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 960           if ($dao->fetch()) {
 961             $params['default_value'] = $dao->id;
 962           }
 963           break;
 964
 965         case 'Country':
 966           $fieldCountry = $strtolower($params['default_value']);
 967           $query = "
 968 SELECT id
 969   FROM civicrm_country
 970  WHERE LOWER(name) = '$fieldCountry'
 971     OR iso_code = '$fieldCountry'";
 972           $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 973           if ($dao->fetch()) {
 974             $params['default_value'] = $dao->id;
 975           }
 976           break;
 977       }
 978     }
 979
 980     // The text_length attribute for Memo fields is in a different input as there
 981     // are different label, help text and default value than for other type fields
 982     if ($params['data_type'] == "Memo") {
 983       $params['text_length'] = $params['note_length'];
 984     }
 985
 986     // need the FKEY - custom group id
 987     $params['custom_group_id'] = $this->_gid;
 988
 989     if ($this->_action & CRM_Core_Action::UPDATE) {
 990       $params['id'] = $this->_id;
 991     }
 992     $customField = CRM_Core_BAO_CustomField::create($params);
 993     $this->_id = $customField->id;
 994
 995     // reset the cache
 996     CRM_Core_BAO_Cache::deleteGroup('contact fields');
 997
 998     $msg = '<p>' . ts("Custom field '%1' has been saved.", array(1 => $customField->label)) . '</p>';
 999
1000     $buttonName = $this->controller->getButtonName();
1001     $session = CRM_Core_Session::singleton();
1002     if ($buttonName == $this->getButtonName('next', 'new')) {
1003       $msg .= '<p>' . ts("Ready to add another.") . '</p>';
1004       $session->replaceUserContext(CRM_Utils_System::url('civicrm/admin/custom/group/field/add',
1005           'reset=1&action=add&gid=' . $this->_gid
1006         ));
1007     }
1008     else {
1009       $session->replaceUserContext(CRM_Utils_System::url('civicrm/admin/custom/group/field',
1010           'reset=1&action=browse&gid=' . $this->_gid
1011         ));
1012     }
1013     $session->setStatus($msg, ts('Saved'), 'success');
1014
1015     // Add data when in ajax contect
1016     $this->ajaxResponse['customField'] = $customField->toArray();
1017   }
1018 }
1019