CRM/Core/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This is our base form. It is part of the Form/Controller/StateMachine
  14  * trifecta. Each form is associated with a specific state in the state
  15  * machine. Each form can also operate in various modes
  16  *
  17  * @package CRM
  18  * @copyright CiviCRM LLC https://civicrm.org/licensing
  19  */
  20
  21 require_once 'HTML/QuickForm/Page.php';
  22
  23 /**
  24  * Class CRM_Core_Form
  25  */
  26 class CRM_Core_Form extends HTML_QuickForm_Page {
  27
  28   /**
  29    * The state object that this form belongs to
  30    * @var object
  31    */
  32   protected $_state;
  33
  34   /**
  35    * The name of this form
  36    * @var string
  37    */
  38   protected $_name;
  39
  40   /**
  41    * The title of this form
  42    * @var string
  43    */
  44   protected $_title = NULL;
  45
  46   /**
  47    * The default values for the form.
  48    *
  49    * @var array
  50    */
  51   public $_defaults = [];
  52
  53   /**
  54    * (QUASI-PROTECTED) The options passed into this form
  55    *
  56    * This field should marked `protected` and is not generally
  57    * intended for external callers, but some edge-cases do use it.
  58    *
  59    * @var mixed
  60    */
  61   public $_options = NULL;
  62
  63   /**
  64    * (QUASI-PROTECTED) The mode of operation for this form
  65    *
  66    * This field should marked `protected` and is not generally
  67    * intended for external callers, but some edge-cases do use it.
  68    *
  69    * @var int
  70    */
  71   public $_action;
  72
  73   /**
  74    * Available payment processors.
  75    *
  76    * As part of trying to consolidate various payment pages we store processors here & have functions
  77    * at this level to manage them.
  78    *
  79    * @var array
  80    *   An array of payment processor details with objects loaded in the 'object' field.
  81    */
  82   protected $_paymentProcessors;
  83
  84   /**
  85    * Available payment processors (IDS).
  86    *
  87    * As part of trying to consolidate various payment pages we store processors here & have functions
  88    * at this level to manage them. An alternative would be to have a separate Form that is inherited
  89    * by all forms that allow payment processing.
  90    *
  91    * @var array
  92    *   An array of the IDS available on this form.
  93    */
  94   public $_paymentProcessorIDs;
  95
  96   /**
  97    * Default or selected processor id.
  98    *
  99    * As part of trying to consolidate various payment pages we store processors here & have functions
 100    * at this level to manage them. An alternative would be to have a separate Form that is inherited
 101    * by all forms that allow payment processing.
 102    *
 103    * @var int
 104    */
 105   protected $_paymentProcessorID;
 106
 107   /**
 108    * Is pay later enabled for the form.
 109    *
 110    * As part of trying to consolidate various payment pages we store processors here & have functions
 111    * at this level to manage them. An alternative would be to have a separate Form that is inherited
 112    * by all forms that allow payment processing.
 113    *
 114    * @var int
 115    */
 116   protected $_is_pay_later_enabled;
 117
 118   /**
 119    * The renderer used for this form
 120    *
 121    * @var object
 122    */
 123   protected $_renderer;
 124
 125   /**
 126    * An array to hold a list of datefields on the form
 127    * so that they can be converted to ISO in a consistent manner
 128    *
 129    * @var array
 130    *
 131    * e.g on a form declare $_dateFields = array(
 132    *  'receive_date' => array('default' => 'now'),
 133    *  );
 134    *  then in postProcess call $this->convertDateFieldsToMySQL($formValues)
 135    *  to have the time field re-incorporated into the field & 'now' set if
 136    *  no value has been passed in
 137    */
 138   protected $_dateFields = [];
 139
 140   /**
 141    * Cache the smarty template for efficiency reasons
 142    *
 143    * @var CRM_Core_Smarty
 144    */
 145   static protected $_template;
 146
 147   /**
 148    *  Indicate if this form should warn users of unsaved changes
 149    * @var bool
 150    */
 151   protected $unsavedChangesWarn;
 152
 153   /**
 154    * What to return to the client if in ajax mode (snippet=json)
 155    *
 156    * @var array
 157    */
 158   public $ajaxResponse = [];
 159
 160   /**
 161    * Url path used to reach this page
 162    *
 163    * @var array
 164    */
 165   public $urlPath = [];
 166
 167   /**
 168    * Context of the form being loaded.
 169    *
 170    * 'event' or null
 171    *
 172    * @var string
 173    */
 174   protected $context;
 175
 176   /**
 177    * @var bool
 178    */
 179   public $submitOnce = FALSE;
 180
 181   /**
 182    * @return string
 183    */
 184   public function getContext() {
 185     return $this->context;
 186   }
 187
 188   /**
 189    * Set context variable.
 190    */
 191   public function setContext() {
 192     $this->context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 193   }
 194
 195   /**
 196    * @var CRM_Core_Controller
 197    */
 198   public $controller;
 199
 200   /**
 201    * Constants for attributes for various form elements
 202    * attempt to standardize on the number of variations that we
 203    * use of the below form elements
 204    *
 205    * @var const string
 206    */
 207   const ATTR_SPACING = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
 208
 209   /**
 210    * All checkboxes are defined with a common prefix. This allows us to
 211    * have the same javascript to check / clear all the checkboxes etc
 212    * If u have multiple groups of checkboxes, you will need to give them different
 213    * ids to avoid potential name collision
 214    *
 215    * @var string|int
 216    */
 217   const CB_PREFIX = 'mark_x_', CB_PREFIY = 'mark_y_', CB_PREFIZ = 'mark_z_', CB_PREFIX_LEN = 7;
 218
 219   /**
 220    * @var array
 221    * @internal to keep track of chain-select fields
 222    */
 223   private $_chainSelectFields = [];
 224
 225   /**
 226    * Extra input types we support via the "add" method
 227    * @var array
 228    */
 229   public static $html5Types = [
 230     'number',
 231     'url',
 232     'email',
 233     'color',
 234   ];
 235
 236   /**
 237    * Constructor for the basic form page.
 238    *
 239    * We should not use QuickForm directly. This class provides a lot
 240    * of default convenient functions, rules and buttons
 241    *
 242    * @param object $state
 243    *   State associated with this form.
 244    * @param \const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete)
 245    * @param string $method
 246    *   The type of http method used (GET/POST).
 247    * @param string $name
 248    *   The name of the form if different from class name.
 249    *
 250    * @return \CRM_Core_Form
 251    */
 252   public function __construct(
 253     $state = NULL,
 254     $action = CRM_Core_Action::NONE,
 255     $method = 'post',
 256     $name = NULL
 257   ) {
 258
 259     if ($name) {
 260       $this->_name = $name;
 261     }
 262     else {
 263       // CRM-15153 - FIXME this name translates to a DOM id and is not always unique!
 264       $this->_name = CRM_Utils_String::getClassName(CRM_Utils_System::getClassName($this));
 265     }
 266
 267     parent::__construct($this->_name, $method);
 268
 269     $this->_state =& $state;
 270     if ($this->_state) {
 271       $this->_state->setName($this->_name);
 272     }
 273     $this->_action = (int) $action;
 274
 275     $this->registerRules();
 276
 277     // let the constructor initialize this, should happen only once
 278     if (!isset(self::$_template)) {
 279       self::$_template = CRM_Core_Smarty::singleton();
 280     }
 281     // Workaround for CRM-15153 - give each form a reasonably unique css class
 282     $this->addClass(CRM_Utils_System::getClassName($this));
 283
 284     $this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET));
 285     $this->setTranslatedFields();
 286   }
 287
 288   /**
 289    * Set translated fields.
 290    *
 291    * This function is called from the class constructor, allowing us to set
 292    * fields on the class that can't be set as properties due to need for
 293    * translation or other non-input specific handling.
 294    */
 295   protected function setTranslatedFields() {}
 296
 297   /**
 298    * Add one or more css classes to the form.
 299    *
 300    * @param string $className
 301    */
 302   public function addClass($className) {
 303     $classes = $this->getAttribute('class');
 304     $this->setAttribute('class', ($classes ? "$classes " : '') . $className);
 305   }
 306
 307   /**
 308    * Register all the standard rules that most forms potentially use.
 309    */
 310   public function registerRules() {
 311     static $rules = [
 312       'title',
 313       'longTitle',
 314       'variable',
 315       'qfVariable',
 316       'phone',
 317       'integer',
 318       'query',
 319       'url',
 320       'wikiURL',
 321       'domain',
 322       'numberOfDigit',
 323       'date',
 324       'currentDate',
 325       'asciiFile',
 326       'htmlFile',
 327       'utf8File',
 328       'objectExists',
 329       'optionExists',
 330       'postalCode',
 331       'money',
 332       'positiveInteger',
 333       'xssString',
 334       'fileExists',
 335       'settingPath',
 336       'autocomplete',
 337       'validContact',
 338     ];
 339
 340     foreach ($rules as $rule) {
 341       $this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule');
 342     }
 343   }
 344
 345   /**
 346    * Simple easy to use wrapper around addElement.
 347    *
 348    * Deal with simple validation rules.
 349    *
 350    * @param string $type
 351    * @param string $name
 352    * @param string $label
 353    * @param string|array $attributes (options for select elements)
 354    * @param bool $required
 355    * @param array $extra
 356    *   (attributes for select elements).
 357    *   For datepicker elements this is consistent with the data
 358    *   from CRM_Utils_Date::getDatePickerExtra
 359    *
 360    * @return HTML_QuickForm_Element
 361    *   Could be an error object
 362    */
 363   public function &add(
 364     $type, $name, $label = '',
 365     $attributes = '', $required = FALSE, $extra = NULL
 366   ) {
 367     // Fudge some extra types that quickform doesn't support
 368     $inputType = $type;
 369     if ($type == 'wysiwyg' || in_array($type, self::$html5Types)) {
 370       $attributes = ($attributes ? $attributes : []) + ['class' => ''];
 371       $attributes['class'] = ltrim($attributes['class'] . " crm-form-$type");
 372       if ($type == 'wysiwyg' && isset($attributes['preset'])) {
 373         $attributes['data-preset'] = $attributes['preset'];
 374         unset($attributes['preset']);
 375       }
 376       $type = $type == 'wysiwyg' ? 'textarea' : 'text';
 377     }
 378     // Like select but accepts rich array data (with nesting, colors, icons, etc) as option list.
 379     if ($inputType == 'select2') {
 380       $type = 'text';
 381       $options = $attributes;
 382       $attributes = ($extra ? $extra : []) + ['class' => ''];
 383       $attributes['class'] = ltrim($attributes['class'] . " crm-select2 crm-form-select2");
 384       $attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]);
 385       unset($attributes['multiple']);
 386       $extra = NULL;
 387     }
 388     // @see http://wiki.civicrm.org/confluence/display/CRMDOC/crmDatepicker
 389     if ($type == 'datepicker') {
 390       $attributes = ($attributes ? $attributes : []);
 391       $attributes['data-crm-datepicker'] = json_encode((array) $extra);
 392       if (!empty($attributes['aria-label']) || $label) {
 393         $attributes['aria-label'] = CRM_Utils_Array::value('aria-label', $attributes, $label);
 394       }
 395       $type = "text";
 396     }
 397     if ($type == 'select' && is_array($extra)) {
 398       // Normalize this property
 399       if (!empty($extra['multiple'])) {
 400         $extra['multiple'] = 'multiple';
 401       }
 402       else {
 403         unset($extra['multiple']);
 404       }
 405       unset($extra['size'], $extra['maxlength']);
 406       // Add placeholder option for select
 407       if (isset($extra['placeholder'])) {
 408         if ($extra['placeholder'] === TRUE) {
 409           $extra['placeholder'] = $required ? ts('- select -') : ts('- none -');
 410         }
 411         if (($extra['placeholder'] || $extra['placeholder'] === '') && empty($extra['multiple']) && is_array($attributes) && !isset($attributes[''])) {
 412           $attributes = ['' => $extra['placeholder']] + $attributes;
 413         }
 414       }
 415     }
 416     $element = $this->addElement($type, $name, $label, $attributes, $extra);
 417     if (HTML_QuickForm::isError($element)) {
 418       CRM_Core_Error::fatal(HTML_QuickForm::errorMessage($element));
 419     }
 420
 421     if ($inputType == 'color') {
 422       $this->addRule($name, ts('%1 must contain a color value e.g. #ffffff.', [1 => $label]), 'regex', '/#[0-9a-fA-F]{6}/');
 423     }
 424
 425     if ($required) {
 426       if ($type == 'file') {
 427         $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'uploadedfile');
 428       }
 429       else {
 430         $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'required');
 431       }
 432       if (HTML_QuickForm::isError($error)) {
 433         CRM_Core_Error::fatal(HTML_QuickForm::errorMessage($element));
 434       }
 435     }
 436
 437     // Add context for the editing of option groups
 438     if (isset($extra['option_context'])) {
 439       $context = json_encode($extra['option_context']);
 440       $element->setAttribute('data-option-edit-context', $context);
 441     }
 442
 443     return $element;
 444   }
 445
 446   /**
 447    * Preprocess form.
 448    *
 449    * This is called before buildForm. Any pre-processing that
 450    * needs to be done for buildForm should be done here.
 451    *
 452    * This is a virtual function and should be redefined if needed.
 453    */
 454   public function preProcess() {
 455   }
 456
 457   /**
 458    * Called after the form is validated.
 459    *
 460    * Any processing of form state etc should be done in this function.
 461    * Typically all processing associated with a form should be done
 462    * here and relevant state should be stored in the session
 463    *
 464    * This is a virtual function and should be redefined if needed
 465    */
 466   public function postProcess() {
 467   }
 468
 469   /**
 470    * Main process wrapper.
 471    *
 472    * Implemented so that we can call all the hook functions.
 473    *
 474    * @param bool $allowAjax
 475    *   FIXME: This feels kind of hackish, ideally we would take the json-related code from this function.
 476    *                          and bury it deeper down in the controller
 477    */
 478   public function mainProcess($allowAjax = TRUE) {
 479     $this->postProcess();
 480     $this->postProcessHook();
 481
 482     // Respond with JSON if in AJAX context (also support legacy value '6')
 483     if ($allowAjax && !empty($_REQUEST['snippet']) && in_array($_REQUEST['snippet'], [
 484       CRM_Core_Smarty::PRINT_JSON,
 485       6,
 486     ])) {
 487       $this->ajaxResponse['buttonName'] = str_replace('_qf_' . $this->getAttribute('id') . '_', '', $this->controller->getButtonName());
 488       $this->ajaxResponse['action'] = $this->_action;
 489       if (isset($this->_id) || isset($this->id)) {
 490         $this->ajaxResponse['id'] = isset($this->id) ? $this->id : $this->_id;
 491       }
 492       CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 493     }
 494   }
 495
 496   /**
 497    * The postProcess hook is typically called by the framework.
 498    *
 499    * However in a few cases, the form exits or redirects early in which
 500    * case it needs to call this function so other modules can do the needful
 501    * Calling this function directly should be avoided if possible. In general a
 502    * better way is to do setUserContext so the framework does the redirect
 503    */
 504   public function postProcessHook() {
 505     CRM_Utils_Hook::postProcess(get_class($this), $this);
 506   }
 507
 508   /**
 509    * This virtual function is used to build the form.
 510    *
 511    * It replaces the buildForm associated with QuickForm_Page. This allows us to put
 512    * preProcess in front of the actual form building routine
 513    */
 514   public function buildQuickForm() {
 515   }
 516
 517   /**
 518    * This virtual function is used to set the default values of various form elements.
 519    *
 520    * @return array|NULL
 521    *   reference to the array of default values
 522    */
 523   public function setDefaultValues() {
 524     return NULL;
 525   }
 526
 527   /**
 528    * This is a virtual function that adds group and global rules to the form.
 529    *
 530    * Keeping it distinct from the form to keep code small
 531    * and localized in the form building code
 532    */
 533   public function addRules() {
 534   }
 535
 536   /**
 537    * Performs the server side validation.
 538    * @since     1.0
 539    * @return bool
 540    *   true if no error found
 541    * @throws    HTML_QuickForm_Error
 542    */
 543   public function validate() {
 544     $error = parent::validate();
 545
 546     $this->validateChainSelectFields();
 547
 548     $hookErrors = [];
 549
 550     CRM_Utils_Hook::validateForm(
 551       get_class($this),
 552       $this->_submitValues,
 553       $this->_submitFiles,
 554       $this,
 555       $hookErrors
 556     );
 557
 558     if (!empty($hookErrors)) {
 559       $this->_errors += $hookErrors;
 560     }
 561
 562     return (0 == count($this->_errors));
 563   }
 564
 565   /**
 566    * Core function that builds the form.
 567    *
 568    * We redefine this function here and expect all CRM forms to build their form in the function
 569    * buildQuickForm.
 570    */
 571   public function buildForm() {
 572     $this->_formBuilt = TRUE;
 573
 574     $this->preProcess();
 575
 576     CRM_Utils_Hook::preProcess(get_class($this), $this);
 577
 578     $this->assign('translatePermission', CRM_Core_Permission::check('translate CiviCRM'));
 579
 580     if (
 581       $this->controller->_key &&
 582       $this->controller->_generateQFKey
 583     ) {
 584       $this->addElement('hidden', 'qfKey', $this->controller->_key);
 585       $this->assign('qfKey', $this->controller->_key);
 586
 587     }
 588
 589     // _generateQFKey suppresses the qfKey generation on form snippets that
 590     // are part of other forms, hence we use that to avoid adding entryURL
 591     if ($this->controller->_generateQFKey && $this->controller->_entryURL) {
 592       $this->addElement('hidden', 'entryURL', $this->controller->_entryURL);
 593     }
 594
 595     $this->buildQuickForm();
 596
 597     $defaults = $this->setDefaultValues();
 598     unset($defaults['qfKey']);
 599
 600     if (!empty($defaults)) {
 601       $this->setDefaults($defaults);
 602     }
 603
 604     // call the form hook
 605     // also call the hook function so any modules can set their own custom defaults
 606     // the user can do both the form and set default values with this hook
 607     CRM_Utils_Hook::buildForm(get_class($this), $this);
 608
 609     $this->addRules();
 610
 611     //Set html data-attribute to enable warning user of unsaved changes
 612     if ($this->unsavedChangesWarn === TRUE
 613       || (!isset($this->unsavedChangesWarn)
 614         && ($this->_action & CRM_Core_Action::ADD || $this->_action & CRM_Core_Action::UPDATE)
 615       )
 616     ) {
 617       $this->setAttribute('data-warn-changes', 'true');
 618     }
 619
 620     if ($this->submitOnce) {
 621       $this->setAttribute('data-submit-once', 'true');
 622     }
 623   }
 624
 625   /**
 626    * Add default Next / Back buttons.
 627    *
 628    * @param array $params
 629    *   Array of associative arrays in the order in which the buttons should be
 630    *   displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault'
 631    *   The base form class will define a bunch of static arrays for commonly used
 632    *   formats.
 633    */
 634   public function addButtons($params) {
 635     $prevnext = $spacing = [];
 636     foreach ($params as $button) {
 637       if (!empty($button['submitOnce'])) {
 638         $this->submitOnce = TRUE;
 639       }
 640
 641       $attrs = ['class' => 'crm-form-submit'] + (array) CRM_Utils_Array::value('js', $button);
 642
 643       if (!empty($button['class'])) {
 644         $attrs['class'] .= ' ' . $button['class'];
 645       }
 646
 647       if (!empty($button['isDefault'])) {
 648         $attrs['class'] .= ' default';
 649       }
 650
 651       if (in_array($button['type'], ['upload', 'next', 'submit', 'done', 'process', 'refresh'])) {
 652         $attrs['class'] .= ' validate';
 653         $defaultIcon = 'fa-check';
 654       }
 655       else {
 656         $attrs['class'] .= ' cancel';
 657         $defaultIcon = $button['type'] == 'back' ? 'fa-chevron-left' : 'fa-times';
 658       }
 659
 660       if ($button['type'] === 'reset') {
 661         $prevnext[] = $this->createElement($button['type'], 'reset', $button['name'], $attrs);
 662       }
 663       else {
 664         if (!empty($button['subName'])) {
 665           if ($button['subName'] == 'new') {
 666             $defaultIcon = 'fa-plus-circle';
 667           }
 668           if ($button['subName'] == 'done') {
 669             $defaultIcon = 'fa-check-circle';
 670           }
 671           if ($button['subName'] == 'next') {
 672             $defaultIcon = 'fa-chevron-right';
 673           }
 674         }
 675
 676         if (in_array($button['type'], ['next', 'upload', 'done']) && $button['name'] === ts('Save')) {
 677           $attrs['accesskey'] = 'S';
 678         }
 679         $icon = CRM_Utils_Array::value('icon', $button, $defaultIcon);
 680         if ($icon) {
 681           $attrs['crm-icon'] = $icon;
 682         }
 683         $buttonName = $this->getButtonName($button['type'], CRM_Utils_Array::value('subName', $button));
 684         $prevnext[] = $this->createElement('submit', $buttonName, $button['name'], $attrs);
 685       }
 686       if (!empty($button['isDefault'])) {
 687         $this->setDefaultAction($button['type']);
 688       }
 689
 690       // if button type is upload, set the enctype
 691       if ($button['type'] == 'upload') {
 692         $this->updateAttributes(['enctype' => 'multipart/form-data']);
 693         $this->setMaxFileSize();
 694       }
 695
 696       // hack - addGroup uses an array to express variable spacing, read from the last element
 697       $spacing[] = CRM_Utils_Array::value('spacing', $button, self::ATTR_SPACING);
 698     }
 699     $this->addGroup($prevnext, 'buttons', '', $spacing, FALSE);
 700   }
 701
 702   /**
 703    * Getter function for Name.
 704    *
 705    * @return string
 706    */
 707   public function getName() {
 708     return $this->_name;
 709   }
 710
 711   /**
 712    * Getter function for State.
 713    *
 714    * @return object
 715    */
 716   public function &getState() {
 717     return $this->_state;
 718   }
 719
 720   /**
 721    * Getter function for StateType.
 722    *
 723    * @return int
 724    */
 725   public function getStateType() {
 726     return $this->_state->getType();
 727   }
 728
 729   /**
 730    * Getter function for title.
 731    *
 732    * Should be over-ridden by derived class.
 733    *
 734    * @return string
 735    */
 736   public function getTitle() {
 737     return $this->_title ? $this->_title : ts('ERROR: Title is not Set');
 738   }
 739
 740   /**
 741    * Setter function for title.
 742    *
 743    * @param string $title
 744    *   The title of the form.
 745    */
 746   public function setTitle($title) {
 747     $this->_title = $title;
 748     CRM_Utils_System::setTitle($title);
 749   }
 750
 751   /**
 752    * Assign billing type id to bltID.
 753    *
 754    * @throws CRM_Core_Exception
 755    */
 756   public function assignBillingType() {
 757     $this->_bltID = CRM_Core_BAO_LocationType::getBilling();
 758     $this->set('bltID', $this->_bltID);
 759     $this->assign('bltID', $this->_bltID);
 760   }
 761
 762   /**
 763    * @return int
 764    */
 765   public function getPaymentProcessorID() {
 766     return $this->_paymentProcessorID;
 767   }
 768
 769   /**
 770    * This if a front end form function for setting the payment processor.
 771    *
 772    * It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.
 773    *
 774    * @param bool $isPayLaterEnabled
 775    *
 776    * @throws \CRM_Core_Exception
 777    */
 778   protected function assignPaymentProcessor($isPayLaterEnabled) {
 779     $this->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors([ucfirst($this->_mode) . 'Mode'], $this->_paymentProcessorIDs);
 780     if ($isPayLaterEnabled) {
 781       $this->_paymentProcessors[0] = CRM_Financial_BAO_PaymentProcessor::getPayment(0);
 782     }
 783
 784     if (!empty($this->_paymentProcessors)) {
 785       foreach ($this->_paymentProcessors as $paymentProcessorID => $paymentProcessorDetail) {
 786         if (empty($this->_paymentProcessor) && $paymentProcessorDetail['is_default'] == 1 || (count($this->_paymentProcessors) == 1)
 787         ) {
 788           $this->_paymentProcessor = $paymentProcessorDetail;
 789           $this->assign('paymentProcessor', $this->_paymentProcessor);
 790           // Setting this is a bit of a legacy overhang.
 791           $this->_paymentObject = $paymentProcessorDetail['object'];
 792         }
 793       }
 794       // It's not clear why we set this on the form.
 795       $this->set('paymentProcessors', $this->_paymentProcessors);
 796     }
 797     else {
 798       throw new CRM_Core_Exception(ts('A payment processor configured for this page might be disabled (contact the site administrator for assistance).'));
 799     }
 800
 801   }
 802
 803   /**
 804    * Format the fields in $this->_params for the payment processor.
 805    *
 806    * In order to pass fields to the payment processor in a consistent way we add some renamed
 807    * parameters.
 808    *
 809    * @param array $fields
 810    *
 811    * @return array
 812    */
 813   protected function formatParamsForPaymentProcessor($fields) {
 814     $this->_params = $this->prepareParamsForPaymentProcessor($this->_params);
 815     $fields = array_merge($fields, ['first_name' => 1, 'middle_name' => 1, 'last_name' => 1]);
 816     return $fields;
 817   }
 818
 819   /**
 820    * Format the fields in $params for the payment processor.
 821    *
 822    * In order to pass fields to the payment processor in a consistent way we add some renamed
 823    * parameters.
 824    *
 825    * @param array $params Payment processor params
 826    *
 827    * @return array $params
 828    */
 829   protected function prepareParamsForPaymentProcessor($params) {
 830     // also add location name to the array
 831     $params["address_name-{$this->_bltID}"] = CRM_Utils_Array::value('billing_first_name', $params) . ' ' . CRM_Utils_Array::value('billing_middle_name', $params) . ' ' . CRM_Utils_Array::value('billing_last_name', $params);
 832     $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
 833     // Add additional parameters that the payment processors are used to receiving.
 834     if (!empty($params["billing_state_province_id-{$this->_bltID}"])) {
 835       $params['state_province'] = $params["state_province-{$this->_bltID}"] = $params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($params["billing_state_province_id-{$this->_bltID}"]);
 836     }
 837     if (!empty($params["billing_country_id-{$this->_bltID}"])) {
 838       $params['country'] = $params["country-{$this->_bltID}"] = $params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($params["billing_country_id-{$this->_bltID}"]);
 839     }
 840
 841     list($hasAddressField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($params, $this->_bltID);
 842     if ($hasAddressField) {
 843       $params = array_merge($params, $addressParams);
 844     }
 845
 846     // How does this relate to similar code in CRM_Contact_BAO_Contact::addBillingNameFieldsIfOtherwiseNotSet()?
 847     $nameFields = ['first_name', 'middle_name', 'last_name'];
 848     foreach ($nameFields as $name) {
 849       if (array_key_exists("billing_$name", $params)) {
 850         $params[$name] = $params["billing_{$name}"];
 851         $params['preserveDBName'] = TRUE;
 852       }
 853     }
 854
 855     // For legacy reasons we set these creditcard expiry fields if present
 856     if (isset($params['credit_card_exp_date'])) {
 857       $params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($params);
 858       $params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($params);
 859     }
 860
 861     // Assign IP address parameter
 862     $params['ip_address'] = CRM_Utils_System::ipAddress();
 863
 864     return $params;
 865   }
 866
 867   /**
 868    * Handle Payment Processor switching for contribution and event registration forms.
 869    *
 870    * This function is shared between contribution & event forms & this is their common class.
 871    *
 872    * However, this should be seen as an in-progress refactor, the end goal being to also align the
 873    * backoffice forms that action payments.
 874    *
 875    * This function overlaps assignPaymentProcessor, in a bad way.
 876    */
 877   protected function preProcessPaymentOptions() {
 878     $this->_paymentProcessorID = NULL;
 879     if ($this->_paymentProcessors) {
 880       if (!empty($this->_submitValues)) {
 881         $this->_paymentProcessorID = CRM_Utils_Array::value('payment_processor_id', $this->_submitValues);
 882         $this->_paymentProcessor = CRM_Utils_Array::value($this->_paymentProcessorID, $this->_paymentProcessors);
 883         $this->set('type', $this->_paymentProcessorID);
 884         $this->set('mode', $this->_mode);
 885         $this->set('paymentProcessor', $this->_paymentProcessor);
 886       }
 887       // Set default payment processor
 888       else {
 889         foreach ($this->_paymentProcessors as $values) {
 890           if (!empty($values['is_default']) || count($this->_paymentProcessors) == 1) {
 891             $this->_paymentProcessorID = $values['id'];
 892             break;
 893           }
 894         }
 895       }
 896       if ($this->_paymentProcessorID
 897         || (isset($this->_submitValues['payment_processor_id']) && $this->_submitValues['payment_processor_id'] == 0)
 898       ) {
 899         CRM_Core_Payment_ProcessorForm::preProcess($this);
 900       }
 901       else {
 902         $this->_paymentProcessor = [];
 903       }
 904     }
 905
 906     // We save the fact that the profile 'billing' is required on the payment form.
 907     // Currently pay-later is the only 'processor' that takes notice of this - but ideally
 908     // 1) it would be possible to select the minimum_billing_profile_id for the contribution form
 909     // 2) that profile_id would be set on the payment processor
 910     // 3) the payment processor would return a billing form that combines these user-configured
 911     // minimums with the payment processor minimums. This would lead to fields like 'postal_code'
 912     // only being on the form if either the admin has configured it as wanted or the processor
 913     // requires it.
 914     $this->assign('billing_profile_id', (CRM_Utils_Array::value('is_billing_required', $this->_values) ? 'billing' : ''));
 915   }
 916
 917   /**
 918    * Handle pre approval for processors.
 919    *
 920    * This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.
 921    *
 922    * This function is shared between contribution & event forms & this is their common class.
 923    *
 924    * However, this should be seen as an in-progress refactor, the end goal being to also align the
 925    * backoffice forms that action payments.
 926    *
 927    * @param array $params
 928    */
 929   protected function handlePreApproval(&$params) {
 930     try {
 931       $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
 932       $params['component'] = 'contribute';
 933       $result = $payment->doPreApproval($params);
 934       if (empty($result)) {
 935         // This could happen, for example, when paypal looks at the button value & decides it is not paypal express.
 936         return;
 937       }
 938     }
 939     catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 940       CRM_Core_Error::statusBounce(ts('Payment approval failed with message :') . $e->getMessage(), $payment->getCancelUrl($params['qfKey'], CRM_Utils_Array::value('participant_id', $params)));
 941     }
 942
 943     $this->set('pre_approval_parameters', $result['pre_approval_parameters']);
 944     if (!empty($result['redirect_url'])) {
 945       CRM_Utils_System::redirect($result['redirect_url']);
 946     }
 947   }
 948
 949   /**
 950    * Setter function for options.
 951    *
 952    * @param mixed $options
 953    */
 954   public function setOptions($options) {
 955     $this->_options = $options;
 956   }
 957
 958   /**
 959    * Render form and return contents.
 960    *
 961    * @return string
 962    */
 963   public function toSmarty() {
 964     $this->preProcessChainSelectFields();
 965     $renderer = $this->getRenderer();
 966     $this->accept($renderer);
 967     $content = $renderer->toArray();
 968     $content['formName'] = $this->getName();
 969     // CRM-15153
 970     $content['formClass'] = CRM_Utils_System::getClassName($this);
 971     return $content;
 972   }
 973
 974   /**
 975    * Getter function for renderer.
 976    *
 977    * If renderer is not set create one and initialize it.
 978    *
 979    * @return object
 980    */
 981   public function &getRenderer() {
 982     if (!isset($this->_renderer)) {
 983       $this->_renderer = CRM_Core_Form_Renderer::singleton();
 984     }
 985     return $this->_renderer;
 986   }
 987
 988   /**
 989    * Use the form name to create the tpl file name.
 990    *
 991    * @return string
 992    */
 993   public function getTemplateFileName() {
 994     $ext = CRM_Extension_System::singleton()->getMapper();
 995     if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this))) {
 996       $filename = $ext->getTemplateName(CRM_Utils_System::getClassName($this));
 997       $tplname = $ext->getTemplatePath(CRM_Utils_System::getClassName($this)) . DIRECTORY_SEPARATOR . $filename;
 998     }
 999     else {
1000       $tplname = strtr(
1001         CRM_Utils_System::getClassName($this),
1002         [
1003           '_' => DIRECTORY_SEPARATOR,
1004           '\\' => DIRECTORY_SEPARATOR,
1005         ]
1006       ) . '.tpl';
1007     }
1008     return $tplname;
1009   }
1010
1011   /**
1012    * A wrapper for getTemplateFileName.
1013    *
1014    * This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
1015    */
1016   public function getHookedTemplateFileName() {
1017     $pageTemplateFile = $this->getTemplateFileName();
1018     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
1019     return $pageTemplateFile;
1020   }
1021
1022   /**
1023    * Default extra tpl file basically just replaces .tpl with .extra.tpl.
1024    *
1025    * i.e. we do not override.
1026    *
1027    * @return string
1028    */
1029   public function overrideExtraTemplateFileName() {
1030     return NULL;
1031   }
1032
1033   /**
1034    * Error reporting mechanism.
1035    *
1036    * @param string $message
1037    *   Error Message.
1038    * @param int $code
1039    *   Error Code.
1040    * @param CRM_Core_DAO $dao
1041    *   A data access object on which we perform a rollback if non - empty.
1042    */
1043   public function error($message, $code = NULL, $dao = NULL) {
1044     if ($dao) {
1045       $dao->query('ROLLBACK');
1046     }
1047
1048     $error = CRM_Core_Error::singleton();
1049
1050     $error->push($code, $message);
1051   }
1052
1053   /**
1054    * Store the variable with the value in the form scope.
1055    *
1056    * @param string $name
1057    *   Name of the variable.
1058    * @param mixed $value
1059    *   Value of the variable.
1060    */
1061   public function set($name, $value) {
1062     $this->controller->set($name, $value);
1063   }
1064
1065   /**
1066    * Get the variable from the form scope.
1067    *
1068    * @param string $name
1069    *   Name of the variable
1070    *
1071    * @return mixed
1072    */
1073   public function get($name) {
1074     return $this->controller->get($name);
1075   }
1076
1077   /**
1078    * Getter for action.
1079    *
1080    * @return int
1081    */
1082   public function getAction() {
1083     return $this->_action;
1084   }
1085
1086   /**
1087    * Setter for action.
1088    *
1089    * @param int $action
1090    *   The mode we want to set the form.
1091    */
1092   public function setAction($action) {
1093     $this->_action = $action;
1094   }
1095
1096   /**
1097    * Assign value to name in template.
1098    *
1099    * @param string $var
1100    *   Name of variable.
1101    * @param mixed $value
1102    *   Value of variable.
1103    */
1104   public function assign($var, $value = NULL) {
1105     self::$_template->assign($var, $value);
1106   }
1107
1108   /**
1109    * Assign value to name in template by reference.
1110    *
1111    * @param string $var
1112    *   Name of variable.
1113    * @param mixed $value
1114    *   Value of variable.
1115    */
1116   public function assign_by_ref($var, &$value) {
1117     self::$_template->assign_by_ref($var, $value);
1118   }
1119
1120   /**
1121    * Appends values to template variables.
1122    *
1123    * @param array|string $tpl_var the template variable name(s)
1124    * @param mixed $value
1125    *   The value to append.
1126    * @param bool $merge
1127    */
1128   public function append($tpl_var, $value = NULL, $merge = FALSE) {
1129     self::$_template->append($tpl_var, $value, $merge);
1130   }
1131
1132   /**
1133    * Returns an array containing template variables.
1134    *
1135    * @param string $name
1136    *
1137    * @return array
1138    */
1139   public function get_template_vars($name = NULL) {
1140     return self::$_template->get_template_vars($name);
1141   }
1142
1143   /**
1144    * @param string $name
1145    * @param $title
1146    * @param $values
1147    * @param array $attributes
1148    * @param null $separator
1149    * @param bool $required
1150    *
1151    * @return HTML_QuickForm_group
1152    */
1153   public function &addRadio($name, $title, $values, $attributes = [], $separator = NULL, $required = FALSE) {
1154     $options = [];
1155     $attributes = $attributes ? $attributes : [];
1156     $allowClear = !empty($attributes['allowClear']);
1157     unset($attributes['allowClear']);
1158     $attributes['id_suffix'] = $name;
1159     foreach ($values as $key => $var) {
1160       $options[] = $this->createElement('radio', NULL, NULL, $var, $key, $attributes);
1161     }
1162     $group = $this->addGroup($options, $name, $title, $separator);
1163
1164     $optionEditKey = 'data-option-edit-path';
1165     if (!empty($attributes[$optionEditKey])) {
1166       $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1167     }
1168
1169     if ($required) {
1170       $this->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required');
1171     }
1172     if ($allowClear) {
1173       $group->setAttribute('allowClear', TRUE);
1174     }
1175     return $group;
1176   }
1177
1178   /**
1179    * @param int $id
1180    * @param $title
1181    * @param bool $allowClear
1182    * @param null $required
1183    * @param array $attributes
1184    */
1185   public function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = []) {
1186     $attributes += ['id_suffix' => $id];
1187     $choice = [];
1188     $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes);
1189     $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes);
1190
1191     $group = $this->addGroup($choice, $id, $title);
1192     if ($allowClear) {
1193       $group->setAttribute('allowClear', TRUE);
1194     }
1195     if ($required) {
1196       $this->addRule($id, ts('%1 is a required field.', [1 => $title]), 'required');
1197     }
1198   }
1199
1200   /**
1201    * @param int $id
1202    * @param $title
1203    * @param $values
1204    * @param null $other
1205    * @param null $attributes
1206    * @param null $required
1207    * @param null $javascriptMethod
1208    * @param string $separator
1209    * @param bool $flipValues
1210    */
1211   public function addCheckBox(
1212     $id, $title, $values, $other = NULL,
1213     $attributes = NULL, $required = NULL,
1214     $javascriptMethod = NULL,
1215     $separator = '<br />', $flipValues = FALSE
1216   ) {
1217     $options = [];
1218
1219     if ($javascriptMethod) {
1220       foreach ($values as $key => $var) {
1221         if (!$flipValues) {
1222           $options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod, $attributes);
1223         }
1224         else {
1225           $options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod, $attributes);
1226         }
1227       }
1228     }
1229     else {
1230       foreach ($values as $key => $var) {
1231         if (!$flipValues) {
1232           $options[] = $this->createElement('checkbox', $var, NULL, $key, $attributes);
1233         }
1234         else {
1235           $options[] = $this->createElement('checkbox', $key, NULL, $var, $attributes);
1236         }
1237       }
1238     }
1239
1240     $group = $this->addGroup($options, $id, $title, $separator);
1241     $optionEditKey = 'data-option-edit-path';
1242     if (!empty($attributes[$optionEditKey])) {
1243       $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1244     }
1245
1246     if ($other) {
1247       $this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']);
1248     }
1249
1250     if ($required) {
1251       $this->addRule($id,
1252         ts('%1 is a required field.', [1 => $title]),
1253         'required'
1254       );
1255     }
1256   }
1257
1258   public function resetValues() {
1259     $data = $this->controller->container();
1260     $data['values'][$this->_name] = [];
1261   }
1262
1263   /**
1264    * Simple shell that derived classes can call to add buttons to
1265    * the form with a customized title for the main Submit
1266    *
1267    * @param string $title
1268    *   Title of the main button.
1269    * @param string $nextType
1270    *   Button type for the form after processing.
1271    * @param string $backType
1272    * @param bool|string $submitOnce
1273    */
1274   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
1275     $buttons = [];
1276     if ($backType != NULL) {
1277       $buttons[] = [
1278         'type' => $backType,
1279         'name' => ts('Previous'),
1280       ];
1281     }
1282     if ($nextType != NULL) {
1283       $nextButton = [
1284         'type' => $nextType,
1285         'name' => $title,
1286         'isDefault' => TRUE,
1287       ];
1288       if ($submitOnce) {
1289         $this->submitOnce = TRUE;
1290       }
1291       $buttons[] = $nextButton;
1292     }
1293     $this->addButtons($buttons);
1294   }
1295
1296   /**
1297    * @param string $name
1298    * @param string $from
1299    * @param string $to
1300    * @param string $label
1301    * @param string $dateFormat
1302    * @param bool $required
1303    * @param bool $displayTime
1304    */
1305   public function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
1306     if ($displayTime) {
1307       $this->addDateTime($name . $from, $label, $required, ['formatType' => $dateFormat]);
1308       $this->addDateTime($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1309     }
1310     else {
1311       $this->addDate($name . $from, $label, $required, ['formatType' => $dateFormat]);
1312       $this->addDate($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1313     }
1314   }
1315
1316   /**
1317    * Add a search for a range using date picker fields.
1318    *
1319    * @param string $fieldName
1320    * @param string $label
1321    * @param bool $isDateTime
1322    *   Is this a date-time field (not just date).
1323    * @param bool $required
1324    * @param string $fromLabel
1325    * @param string $toLabel
1326    */
1327   public function addDatePickerRange($fieldName, $label, $isDateTime = FALSE, $required = FALSE, $fromLabel = 'From', $toLabel = 'To') {
1328
1329     $options = [
1330       '' => ts('- any -'),
1331       0 => ts('Choose Date Range'),
1332     ] + CRM_Core_OptionGroup::values('relative_date_filters');
1333
1334     $this->add('select',
1335       "{$fieldName}_relative",
1336       $label,
1337       $options,
1338       $required,
1339       ['class' => 'crm-select2']
1340     );
1341     $attributes = ['format' => 'searchDate'];
1342     $extra = ['time' => $isDateTime];
1343     $this->add('datepicker', $fieldName . '_low', ts($fromLabel), $attributes, $required, $extra);
1344     $this->add('datepicker', $fieldName . '_high', ts($toLabel), $attributes, $required, $extra);
1345   }
1346
1347   /**
1348    * Based on form action, return a string representing the api action.
1349    * Used by addField method.
1350    *
1351    * Return string
1352    */
1353   protected function getApiAction() {
1354     $action = $this->getAction();
1355     if ($action & (CRM_Core_Action::UPDATE + CRM_Core_Action::ADD)) {
1356       return 'create';
1357     }
1358     if ($action & (CRM_Core_Action::VIEW + CRM_Core_Action::BROWSE + CRM_Core_Action::BASIC + CRM_Core_Action::ADVANCED + CRM_Core_Action::PREVIEW)) {
1359       return 'get';
1360     }
1361     if ($action & (CRM_Core_Action::DELETE)) {
1362       return 'delete';
1363     }
1364     // If you get this exception try adding more cases above.
1365     throw new Exception("Cannot determine api action for " . get_class($this) . '.' . 'CRM_Core_Action "' . CRM_Core_Action::description($action) . '" not recognized.');
1366   }
1367
1368   /**
1369    * Classes extending CRM_Core_Form should implement this method.
1370    * @throws Exception
1371    */
1372   public function getDefaultEntity() {
1373     throw new Exception("Cannot determine default entity. " . get_class($this) . " should implement getDefaultEntity().");
1374   }
1375
1376   /**
1377    * Classes extending CRM_Core_Form should implement this method.
1378    *
1379    * TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
1380    * @throws Exception
1381    */
1382   public function getDefaultContext() {
1383     throw new Exception("Cannot determine default context. " . get_class($this) . " should implement getDefaultContext().");
1384   }
1385
1386   /**
1387    * Adds a select based on field metadata.
1388    * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata
1389    * Perhaps a method like $form->bind($name) which would look up all metadata for named field
1390    * @param $name
1391    *   Field name to go on the form.
1392    * @param array $props
1393    *   Mix of html attributes and special properties, namely.
1394    *   - entity (api entity name, can usually be inferred automatically from the form class)
1395    *   - field (field name - only needed if different from name used on the form)
1396    *   - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1397    *   - placeholder - set to NULL to disable
1398    *   - multiple - bool
1399    *   - context - @see CRM_Core_DAO::buildOptionsContext
1400    * @param bool $required
1401    * @throws CRM_Core_Exception
1402    * @return HTML_QuickForm_Element
1403    */
1404   public function addSelect($name, $props = [], $required = FALSE) {
1405     if (!isset($props['entity'])) {
1406       $props['entity'] = $this->getDefaultEntity();
1407     }
1408     if (!isset($props['field'])) {
1409       $props['field'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name;
1410     }
1411     if (!isset($props['context'])) {
1412       try {
1413         $props['context'] = $this->getDefaultContext();
1414       }
1415       // This is not a required param, so we'll ignore if this doesn't exist.
1416       catch (Exception $e) {
1417       }
1418     }
1419     // Fetch options from the api unless passed explicitly
1420     if (isset($props['options'])) {
1421       $options = $props['options'];
1422     }
1423     else {
1424       $info = civicrm_api3($props['entity'], 'getoptions', $props);
1425       $options = $info['values'];
1426     }
1427     if (!array_key_exists('placeholder', $props)) {
1428       $props['placeholder'] = $required ? ts('- select -') : CRM_Utils_Array::value('context', $props) == 'search' ? ts('- any -') : ts('- none -');
1429     }
1430     // Handle custom field
1431     if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1432       list(, $id) = explode('_', $name);
1433       $label = isset($props['label']) ? $props['label'] : CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id);
1434       $gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id);
1435       if (CRM_Utils_Array::value('context', $props) != 'search') {
1436         $props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $gid);
1437       }
1438     }
1439     // Core field
1440     else {
1441       $info = civicrm_api3($props['entity'], 'getfields');
1442       foreach ($info['values'] as $uniqueName => $fieldSpec) {
1443         if (
1444           $uniqueName === $props['field'] ||
1445           CRM_Utils_Array::value('name', $fieldSpec) === $props['field'] ||
1446           in_array($props['field'], CRM_Utils_Array::value('api.aliases', $fieldSpec, []))
1447         ) {
1448           break;
1449         }
1450       }
1451       $label = isset($props['label']) ? $props['label'] : $fieldSpec['title'];
1452       if (CRM_Utils_Array::value('context', $props) != 'search') {
1453         $props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec);
1454       }
1455     }
1456     $props['class'] = (isset($props['class']) ? $props['class'] . ' ' : '') . "crm-select2";
1457     $props['data-api-entity'] = $props['entity'];
1458     $props['data-api-field'] = $props['field'];
1459     CRM_Utils_Array::remove($props, 'label', 'entity', 'field', 'option_url', 'options', 'context');
1460     return $this->add('select', $name, $label, $options, $required, $props);
1461   }
1462
1463   /**
1464    * Adds a field based on metadata.
1465    *
1466    * @param $name
1467    *   Field name to go on the form.
1468    * @param array $props
1469    *   Mix of html attributes and special properties, namely.
1470    *   - entity (api entity name, can usually be inferred automatically from the form class)
1471    *   - name (field name - only needed if different from name used on the form)
1472    *   - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1473    *   - placeholder - set to NULL to disable
1474    *   - multiple - bool
1475    *   - context - @see CRM_Core_DAO::buildOptionsContext
1476    * @param bool $required
1477    * @param bool $legacyDate
1478    *   Temporary param to facilitate the conversion of fields to use the datepicker in
1479    *   a controlled way. To convert the field the jcalendar code needs to be removed from the
1480    *   tpl as well. That file is intended to be EOL.
1481    *
1482    * @throws \CiviCRM_API3_Exception
1483    * @throws \Exception
1484    * @return mixed
1485    *   HTML_QuickForm_Element
1486    *   void
1487    */
1488   public function addField($name, $props = [], $required = FALSE, $legacyDate = TRUE) {
1489     // Resolve context.
1490     if (empty($props['context'])) {
1491       $props['context'] = $this->getDefaultContext();
1492     }
1493     $context = $props['context'];
1494     // Resolve entity.
1495     if (empty($props['entity'])) {
1496       $props['entity'] = $this->getDefaultEntity();
1497     }
1498     // Resolve field.
1499     if (empty($props['name'])) {
1500       $props['name'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name;
1501     }
1502     // Resolve action.
1503     if (empty($props['action'])) {
1504       $props['action'] = $this->getApiAction();
1505     }
1506
1507     // Handle custom fields
1508     if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1509       $fieldId = (int) substr($name, 7);
1510       return CRM_Core_BAO_CustomField::addQuickFormElement($this, $name, $fieldId, $required, $context == 'search', CRM_Utils_Array::value('label', $props));
1511     }
1512
1513     // Core field - get metadata.
1514     $fieldSpec = civicrm_api3($props['entity'], 'getfield', $props);
1515     $fieldSpec = $fieldSpec['values'];
1516     $fieldSpecLabel = isset($fieldSpec['html']['label']) ? $fieldSpec['html']['label'] : CRM_Utils_Array::value('title', $fieldSpec);
1517     $label = CRM_Utils_Array::value('label', $props, $fieldSpecLabel);
1518
1519     $widget = isset($props['type']) ? $props['type'] : $fieldSpec['html']['type'];
1520     if ($widget == 'TextArea' && $context == 'search') {
1521       $widget = 'Text';
1522     }
1523
1524     $isSelect = (in_array($widget, [
1525       'Select',
1526       'Select2',
1527       'CheckBoxGroup',
1528       'RadioGroup',
1529       'Radio',
1530     ]));
1531
1532     if ($isSelect) {
1533       // Fetch options from the api unless passed explicitly.
1534       if (isset($props['options'])) {
1535         $options = $props['options'];
1536       }
1537       else {
1538         $options = isset($fieldSpec['options']) ? $fieldSpec['options'] : NULL;
1539       }
1540       if ($context == 'search') {
1541         $widget = $widget == 'Select2' ? $widget : 'Select';
1542         $props['multiple'] = CRM_Utils_Array::value('multiple', $props, TRUE);
1543       }
1544
1545       // Add data for popup link.
1546       $canEditOptions = CRM_Core_Permission::check('administer CiviCRM');
1547       $hasOptionUrl = !empty($props['option_url']);
1548       $optionUrlKeyIsSet = array_key_exists('option_url', $props);
1549       $shouldAdd = $context !== 'search' && $isSelect && $canEditOptions;
1550
1551       // Only add if key is not set, or if non-empty option url is provided
1552       if (($hasOptionUrl || !$optionUrlKeyIsSet) && $shouldAdd) {
1553         $optionUrl = $hasOptionUrl ? $props['option_url'] :
1554           CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec);
1555         $props['data-option-edit-path'] = $optionUrl;
1556         $props['data-api-entity'] = $props['entity'];
1557         $props['data-api-field'] = $props['name'];
1558       }
1559     }
1560     $props += CRM_Utils_Array::value('html', $fieldSpec, []);
1561     CRM_Utils_Array::remove($props, 'entity', 'name', 'context', 'label', 'action', 'type', 'option_url', 'options');
1562
1563     // TODO: refactor switch statement, to separate methods.
1564     switch ($widget) {
1565       case 'Text':
1566       case 'Url':
1567       case 'Number':
1568       case 'Email':
1569         //TODO: Autodetect ranges
1570         $props['size'] = isset($props['size']) ? $props['size'] : 60;
1571         return $this->add(strtolower($widget), $name, $label, $props, $required);
1572
1573       case 'hidden':
1574         return $this->add('hidden', $name, NULL, $props, $required);
1575
1576       case 'TextArea':
1577         //Set default columns and rows for textarea.
1578         $props['rows'] = isset($props['rows']) ? $props['rows'] : 4;
1579         $props['cols'] = isset($props['cols']) ? $props['cols'] : 60;
1580         if (empty($props['maxlength']) && isset($fieldSpec['length'])) {
1581           $props['maxlength'] = $fieldSpec['length'];
1582         }
1583         return $this->add('textarea', $name, $label, $props, $required);
1584
1585       case 'Select Date':
1586         // This is a white list for fields that have been tested with
1587         // date picker. We should be able to remove the other
1588         if ($legacyDate) {
1589           //TODO: add range support
1590           //TODO: Add date formats
1591           //TODO: Add javascript template for dates.
1592           return $this->addDate($name, $label, $required, $props);
1593         }
1594         else {
1595           $fieldSpec = CRM_Utils_Date::addDateMetadataToField($fieldSpec, $fieldSpec);
1596           $attributes = ['format' => $fieldSpec['date_format']];
1597           return $this->add('datepicker', $name, $label, $attributes, $required, $fieldSpec['datepicker']['extra']);
1598         }
1599
1600       case 'Radio':
1601         $separator = isset($props['separator']) ? $props['separator'] : NULL;
1602         unset($props['separator']);
1603         if (!isset($props['allowClear'])) {
1604           $props['allowClear'] = !$required;
1605         }
1606         return $this->addRadio($name, $label, $options, $props, $separator, $required);
1607
1608       case 'ChainSelect':
1609         $props += [
1610           'required' => $required,
1611           'label' => $label,
1612           'multiple' => $context == 'search',
1613         ];
1614         return $this->addChainSelect($name, $props);
1615
1616       case 'Select':
1617       case 'Select2':
1618         $props['class'] = CRM_Utils_Array::value('class', $props, 'big') . ' crm-select2';
1619         if (!array_key_exists('placeholder', $props)) {
1620           $props['placeholder'] = $required ? ts('- select -') : ($context == 'search' ? ts('- any -') : ts('- none -'));
1621         }
1622         // TODO: Add and/or option for fields that store multiple values
1623         return $this->add(strtolower($widget), $name, $label, $options, $required, $props);
1624
1625       case 'CheckBoxGroup':
1626         return $this->addCheckBox($name, $label, array_flip($options), $required, $props);
1627
1628       case 'RadioGroup':
1629         return $this->addRadio($name, $label, $options, $props, NULL, $required);
1630
1631       case 'CheckBox':
1632         if ($context === 'search') {
1633           $this->addYesNo($name, $label, TRUE, FALSE, $props);
1634           return;
1635         }
1636         $text = isset($props['text']) ? $props['text'] : NULL;
1637         unset($props['text']);
1638         return $this->addElement('checkbox', $name, $label, $text, $props);
1639
1640       //add support for 'Advcheckbox' field
1641       case 'advcheckbox':
1642         $text = isset($props['text']) ? $props['text'] : NULL;
1643         unset($props['text']);
1644         return $this->addElement('advcheckbox', $name, $label, $text, $props);
1645
1646       case 'File':
1647         // We should not build upload file in search mode.
1648         if ($context == 'search') {
1649           return;
1650         }
1651         $file = $this->add('file', $name, $label, $props, $required);
1652         $this->addUploadElement($name);
1653         return $file;
1654
1655       case 'RichTextEditor':
1656         return $this->add('wysiwyg', $name, $label, $props, $required);
1657
1658       case 'EntityRef':
1659         return $this->addEntityRef($name, $label, $props, $required);
1660
1661       case 'Password':
1662         $props['size'] = isset($props['size']) ? $props['size'] : 60;
1663         return $this->add('password', $name, $label, $props, $required);
1664
1665       // Check datatypes of fields
1666       // case 'Int':
1667       //case 'Float':
1668       //case 'Money':
1669       //case read only fields
1670       default:
1671         throw new Exception("Unsupported html-element " . $widget);
1672     }
1673   }
1674
1675   /**
1676    * Add a widget for selecting/editing/creating/copying a profile form
1677    *
1678    * @param string $name
1679    *   HTML form-element name.
1680    * @param string $label
1681    *   Printable label.
1682    * @param string $allowCoreTypes
1683    *   Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'.
1684    * @param string $allowSubTypes
1685    *   Only present a UFGroup if its group_type is compatible with $allowSubypes.
1686    * @param array $entities
1687    * @param bool $default
1688    *   //CRM-15427.
1689    * @param string $usedFor
1690    */
1691   public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) {
1692     // Output widget
1693     // FIXME: Instead of adhoc serialization, use a single json_encode()
1694     CRM_UF_Page_ProfileEditor::registerProfileScripts();
1695     CRM_UF_Page_ProfileEditor::registerSchemas(CRM_Utils_Array::collect('entity_type', $entities));
1696     $this->add('text', $name, $label, [
1697       'class' => 'crm-profile-selector',
1698       // Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML
1699       'data-group-type' => CRM_Core_BAO_UFGroup::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'),
1700       'data-entities' => json_encode($entities),
1701       //CRM-15427
1702       'data-default' => $default,
1703       'data-usedfor' => json_encode($usedFor),
1704     ]);
1705   }
1706
1707   /**
1708    * @return null
1709    */
1710   public function getRootTitle() {
1711     return NULL;
1712   }
1713
1714   /**
1715    * @return string
1716    */
1717   public function getCompleteTitle() {
1718     return $this->getRootTitle() . $this->getTitle();
1719   }
1720
1721   /**
1722    * @return CRM_Core_Smarty
1723    */
1724   public static function &getTemplate() {
1725     return self::$_template;
1726   }
1727
1728   /**
1729    * @param $elementName
1730    */
1731   public function addUploadElement($elementName) {
1732     $uploadNames = $this->get('uploadNames');
1733     if (!$uploadNames) {
1734       $uploadNames = [];
1735     }
1736     if (is_array($elementName)) {
1737       foreach ($elementName as $name) {
1738         if (!in_array($name, $uploadNames)) {
1739           $uploadNames[] = $name;
1740         }
1741       }
1742     }
1743     else {
1744       if (!in_array($elementName, $uploadNames)) {
1745         $uploadNames[] = $elementName;
1746       }
1747     }
1748     $this->set('uploadNames', $uploadNames);
1749
1750     $config = CRM_Core_Config::singleton();
1751     if (!empty($uploadNames)) {
1752       $this->controller->addUploadAction($config->customFileUploadDir, $uploadNames);
1753     }
1754   }
1755
1756   /**
1757    * @param $name
1758    *
1759    * @return null
1760    */
1761   public function getVar($name) {
1762     return isset($this->$name) ? $this->$name : NULL;
1763   }
1764
1765   /**
1766    * @param $name
1767    * @param $value
1768    */
1769   public function setVar($name, $value) {
1770     $this->$name = $value;
1771   }
1772
1773   /**
1774    * Add date.
1775    *
1776    * @deprecated
1777    * Use $this->add('datepicker', ...) instead.
1778    *
1779    * @param string $name
1780    *   Name of the element.
1781    * @param string $label
1782    *   Label of the element.
1783    * @param bool $required
1784    *   True if required.
1785    * @param array $attributes
1786    *   Key / value pair.
1787    */
1788   public function addDate($name, $label, $required = FALSE, $attributes = NULL) {
1789     if (!empty($attributes['formatType'])) {
1790       // get actual format
1791       $params = ['name' => $attributes['formatType']];
1792       $values = [];
1793
1794       // cache date information
1795       static $dateFormat;
1796       $key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']);
1797       if (empty($dateFormat[$key])) {
1798         CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
1799         $dateFormat[$key] = $values;
1800       }
1801       else {
1802         $values = $dateFormat[$key];
1803       }
1804
1805       if ($values['date_format']) {
1806         $attributes['format'] = $values['date_format'];
1807       }
1808
1809       if (!empty($values['time_format'])) {
1810         $attributes['timeFormat'] = $values['time_format'];
1811       }
1812       $attributes['startOffset'] = $values['start'];
1813       $attributes['endOffset'] = $values['end'];
1814     }
1815
1816     $config = CRM_Core_Config::singleton();
1817     if (empty($attributes['format'])) {
1818       $attributes['format'] = $config->dateInputFormat;
1819     }
1820
1821     if (!isset($attributes['startOffset'])) {
1822       $attributes['startOffset'] = 10;
1823     }
1824
1825     if (!isset($attributes['endOffset'])) {
1826       $attributes['endOffset'] = 10;
1827     }
1828
1829     $this->add('text', $name, $label, $attributes);
1830
1831     if (!empty($attributes['addTime']) || !empty($attributes['timeFormat'])) {
1832
1833       if (!isset($attributes['timeFormat'])) {
1834         $timeFormat = $config->timeInputFormat;
1835       }
1836       else {
1837         $timeFormat = $attributes['timeFormat'];
1838       }
1839
1840       // 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively
1841       if ($timeFormat) {
1842         $show24Hours = TRUE;
1843         if ($timeFormat == 1) {
1844           $show24Hours = FALSE;
1845         }
1846
1847         //CRM-6664 -we are having time element name
1848         //in either flat string or an array format.
1849         $elementName = $name . '_time';
1850         if (substr($name, -1) == ']') {
1851           $elementName = substr($name, 0, strlen($name) - 1) . '_time]';
1852         }
1853
1854         $this->add('text', $elementName, ts('Time'), ['timeFormat' => $show24Hours]);
1855       }
1856     }
1857
1858     if ($required) {
1859       $this->addRule($name, ts('Please select %1', [1 => $label]), 'required');
1860       if (!empty($attributes['addTime']) && !empty($attributes['addTimeRequired'])) {
1861         $this->addRule($elementName, ts('Please enter a time.'), 'required');
1862       }
1863     }
1864   }
1865
1866   /**
1867    * Function that will add date and time.
1868    *
1869    * @deprecated
1870    * Use $this->add('datepicker', ...) instead.
1871    *
1872    * @param string $name
1873    * @param string $label
1874    * @param bool $required
1875    * @param null $attributes
1876    */
1877   public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
1878     $addTime = ['addTime' => TRUE];
1879     if (is_array($attributes)) {
1880       $attributes = array_merge($attributes, $addTime);
1881     }
1882     else {
1883       $attributes = $addTime;
1884     }
1885
1886     $this->addDate($name, $label, $required, $attributes);
1887   }
1888
1889   /**
1890    * Add a currency and money element to the form.
1891    *
1892    * @param string $name
1893    * @param string $label
1894    * @param bool $required
1895    * @param null $attributes
1896    * @param bool $addCurrency
1897    * @param string $currencyName
1898    * @param null $defaultCurrency
1899    * @param bool $freezeCurrency
1900    *
1901    * @return \HTML_QuickForm_Element
1902    */
1903   public function addMoney(
1904     $name,
1905     $label,
1906     $required = FALSE,
1907     $attributes = NULL,
1908     $addCurrency = TRUE,
1909     $currencyName = 'currency',
1910     $defaultCurrency = NULL,
1911     $freezeCurrency = FALSE
1912   ) {
1913     $element = $this->add('text', $name, $label, $attributes, $required);
1914     $this->addRule($name, ts('Please enter a valid amount.'), 'money');
1915
1916     if ($addCurrency) {
1917       $ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency);
1918     }
1919
1920     return $element;
1921   }
1922
1923   /**
1924    * Add currency element to the form.
1925    *
1926    * @param string $name
1927    * @param null $label
1928    * @param bool $required
1929    * @param string $defaultCurrency
1930    * @param bool $freezeCurrency
1931    * @param bool $setDefaultCurrency
1932    */
1933   public function addCurrency(
1934     $name = 'currency',
1935     $label = NULL,
1936     $required = TRUE,
1937     $defaultCurrency = NULL,
1938     $freezeCurrency = FALSE,
1939     $setDefaultCurrency = TRUE
1940   ) {
1941     $currencies = CRM_Core_OptionGroup::values('currencies_enabled');
1942     if (!empty($defaultCurrency) && !array_key_exists($defaultCurrency, $currencies)) {
1943       Civi::log()->warning('addCurrency: Currency ' . $defaultCurrency . ' is disabled but still in use!');
1944       $currencies[$defaultCurrency] = $defaultCurrency;
1945     }
1946     $options = ['class' => 'crm-select2 eight'];
1947     if (!$required) {
1948       $currencies = ['' => ''] + $currencies;
1949       $options['placeholder'] = ts('- none -');
1950     }
1951     $ele = $this->add('select', $name, $label, $currencies, $required, $options);
1952     if ($freezeCurrency) {
1953       $ele->freeze();
1954     }
1955     if (!$defaultCurrency) {
1956       $config = CRM_Core_Config::singleton();
1957       $defaultCurrency = $config->defaultCurrency;
1958     }
1959     // In some case, setting currency field by default might override the default value
1960     //  as encountered in CRM-20527 for batch data entry
1961     if ($setDefaultCurrency) {
1962       $this->setDefaults([$name => $defaultCurrency]);
1963     }
1964   }
1965
1966   /**
1967    * Create a single or multiple entity ref field.
1968    * @param string $name
1969    * @param string $label
1970    * @param array $props
1971    *   Mix of html and widget properties, including:.
1972    *   - select - params to give to select2 widget
1973    *   - entity - defaults to Contact
1974    *   - create - can the user create a new entity on-the-fly?
1975    *             Set to TRUE if entity is contact and you want the default profiles,
1976    *             or pass in your own set of links. @see CRM_Campaign_BAO_Campaign::getEntityRefCreateLinks for format
1977    *             note that permissions are checked automatically
1978    *   - api - array of settings for the getlist api wrapper
1979    *          note that it accepts a 'params' setting which will be passed to the underlying api
1980    *   - placeholder - string
1981    *   - multiple - bool
1982    *   - class, etc. - other html properties
1983    * @param bool $required
1984    *
1985    * @return HTML_QuickForm_Element
1986    */
1987   public function addEntityRef($name, $label = '', $props = [], $required = FALSE) {
1988     // Default properties
1989     $props['api'] = CRM_Utils_Array::value('api', $props, []);
1990     $props['entity'] = CRM_Utils_String::convertStringToCamel(CRM_Utils_Array::value('entity', $props, 'Contact'));
1991     $props['class'] = ltrim(CRM_Utils_Array::value('class', $props, '') . ' crm-form-entityref');
1992
1993     if (array_key_exists('create', $props) && empty($props['create'])) {
1994       unset($props['create']);
1995     }
1996
1997     $props['placeholder'] = CRM_Utils_Array::value('placeholder', $props, $required ? ts('- select %1 -', [1 => ts(str_replace('_', ' ', $props['entity']))]) : ts('- none -'));
1998
1999     $defaults = [];
2000     if (!empty($props['multiple'])) {
2001       $defaults['multiple'] = TRUE;
2002     }
2003     $props['select'] = CRM_Utils_Array::value('select', $props, []) + $defaults;
2004
2005     $this->formatReferenceFieldAttributes($props, get_class($this));
2006     return $this->add('text', $name, $label, $props, $required);
2007   }
2008
2009   /**
2010    * @param array $props
2011    * @param string $formName
2012    */
2013   private function formatReferenceFieldAttributes(&$props, $formName) {
2014     CRM_Utils_Hook::alterEntityRefParams($props, $formName);
2015     $props['data-select-params'] = json_encode($props['select']);
2016     $props['data-api-params'] = $props['api'] ? json_encode($props['api']) : NULL;
2017     $props['data-api-entity'] = $props['entity'];
2018     if (!empty($props['create'])) {
2019       $props['data-create-links'] = json_encode($props['create']);
2020     }
2021     CRM_Utils_Array::remove($props, 'multiple', 'select', 'api', 'entity', 'create');
2022   }
2023
2024   /**
2025    * Convert all date fields within the params to mysql date ready for the
2026    * BAO layer. In this case fields are checked against the $_datefields defined for the form
2027    * and if time is defined it is incorporated
2028    *
2029    * @param array $params
2030    *   Input params from the form.
2031    *
2032    * @todo it would probably be better to work on $this->_params than a passed array
2033    * @todo standardise the format which dates are passed to the BAO layer in & remove date
2034    * handling from BAO
2035    */
2036   public function convertDateFieldsToMySQL(&$params) {
2037     foreach ($this->_dateFields as $fieldName => $specs) {
2038       if (!empty($params[$fieldName])) {
2039         $params[$fieldName] = CRM_Utils_Date::isoToMysql(
2040           CRM_Utils_Date::processDate(
2041             $params[$fieldName],
2042             CRM_Utils_Array::value("{$fieldName}_time", $params), TRUE)
2043         );
2044       }
2045       else {
2046         if (isset($specs['default'])) {
2047           $params[$fieldName] = date('YmdHis', strtotime($specs['default']));
2048         }
2049       }
2050     }
2051   }
2052
2053   /**
2054    * @param $elementName
2055    */
2056   public function removeFileRequiredRules($elementName) {
2057     $this->_required = array_diff($this->_required, [$elementName]);
2058     if (isset($this->_rules[$elementName])) {
2059       foreach ($this->_rules[$elementName] as $index => $ruleInfo) {
2060         if ($ruleInfo['type'] == 'uploadedfile') {
2061           unset($this->_rules[$elementName][$index]);
2062         }
2063       }
2064       if (empty($this->_rules[$elementName])) {
2065         unset($this->_rules[$elementName]);
2066       }
2067     }
2068   }
2069
2070   /**
2071    * Function that can be defined in Form to override or.
2072    * perform specific action on cancel action
2073    */
2074   public function cancelAction() {
2075   }
2076
2077   /**
2078    * Helper function to verify that required fields have been filled.
2079    *
2080    * Typically called within the scope of a FormRule function
2081    *
2082    * @param array $fields
2083    * @param array $values
2084    * @param array $errors
2085    */
2086   public static function validateMandatoryFields($fields, $values, &$errors) {
2087     foreach ($fields as $name => $fld) {
2088       if (!empty($fld['is_required']) && CRM_Utils_System::isNull(CRM_Utils_Array::value($name, $values))) {
2089         $errors[$name] = ts('%1 is a required field.', [1 => $fld['title']]);
2090       }
2091     }
2092   }
2093
2094   /**
2095    * Get contact if for a form object. Prioritise
2096    *   - cid in URL if 0 (on behalf on someoneelse)
2097    *      (@todo consider setting a variable if onbehalf for clarity of downstream 'if's
2098    *   - logged in user id if it matches the one in the cid in the URL
2099    *   - contact id validated from a checksum from a checksum
2100    *   - cid from the url if the caller has ACL permission to view
2101    *   - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
2102    *
2103    * @return NULL|int
2104    */
2105   protected function setContactID() {
2106     $tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
2107     if (isset($this->_params) && !empty($this->_params['select_contact_id'])) {
2108       $tempID = $this->_params['select_contact_id'];
2109     }
2110     if (isset($this->_params, $this->_params[0]) && !empty($this->_params[0]['select_contact_id'])) {
2111       // event form stores as an indexed array, contribution form not so much...
2112       $tempID = $this->_params[0]['select_contact_id'];
2113     }
2114
2115     // force to ignore the authenticated user
2116     if ($tempID === '0' || $tempID === 0) {
2117       // we set the cid on the form so that this will be retained for the Confirm page
2118       // in the multi-page form & prevent us returning the $userID when this is called
2119       // from that page
2120       // we don't really need to set it when $tempID is set because the params have that stored
2121       $this->set('cid', 0);
2122       CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2123       return (int) $tempID;
2124     }
2125
2126     $userID = $this->getLoggedInUserContactID();
2127
2128     if (!is_null($tempID) && $tempID === $userID) {
2129       CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2130       return (int) $userID;
2131     }
2132
2133     //check if this is a checksum authentication
2134     $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this);
2135     if ($userChecksum) {
2136       //check for anonymous user.
2137       $validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($tempID, $userChecksum);
2138       if ($validUser) {
2139         CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2140         CRM_Core_Resources::singleton()->addVars('coreForm', ['checksum' => $userChecksum]);
2141         return $tempID;
2142       }
2143     }
2144     // check if user has permission, CRM-12062
2145     elseif ($tempID && CRM_Contact_BAO_Contact_Permission::allow($tempID)) {
2146       CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2147       return $tempID;
2148     }
2149     if (is_numeric($userID)) {
2150       CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $userID]);
2151     }
2152     return is_numeric($userID) ? $userID : NULL;
2153   }
2154
2155   /**
2156    * Get the contact id that the form is being submitted for.
2157    *
2158    * @return int|null
2159    */
2160   public function getContactID() {
2161     return $this->setContactID();
2162   }
2163
2164   /**
2165    * Get the contact id of the logged in user.
2166    */
2167   public function getLoggedInUserContactID() {
2168     // check if the user is logged in and has a contact ID
2169     $session = CRM_Core_Session::singleton();
2170     return $session->get('userID');
2171   }
2172
2173   /**
2174    * Add autoselector field -if user has permission to view contacts
2175    * If adding this to a form you also need to add to the tpl e.g
2176    *
2177    * {if !empty($selectable)}
2178    * <div class="crm-summary-row">
2179    *   <div class="crm-label">{$form.select_contact.label}</div>
2180    *   <div class="crm-content">
2181    *     {$form.select_contact.html}
2182    *   </div>
2183    * </div>
2184    * {/if}
2185    *
2186    * @param array $profiles
2187    *   Ids of profiles that are on the form (to be autofilled).
2188    * @param array $autoCompleteField
2189    *
2190    *   - name_field
2191    *   - id_field
2192    *   - url (for ajax lookup)
2193    *
2194    * @todo add data attributes so we can deal with multiple instances on a form
2195    */
2196   public function addAutoSelector($profiles = [], $autoCompleteField = []) {
2197     $autoCompleteField = array_merge([
2198       'id_field' => 'select_contact_id',
2199       'placeholder' => ts('Select someone else ...'),
2200       'show_hide' => TRUE,
2201       'api' => ['params' => ['contact_type' => 'Individual']],
2202     ], $autoCompleteField);
2203
2204     if ($this->canUseAjaxContactLookups()) {
2205       $this->assign('selectable', $autoCompleteField['id_field']);
2206       $this->addEntityRef($autoCompleteField['id_field'], NULL, [
2207         'placeholder' => $autoCompleteField['placeholder'],
2208         'api' => $autoCompleteField['api'],
2209       ]);
2210
2211       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/AlternateContactSelector.js', 1, 'html-header')
2212         ->addSetting([
2213           'form' => ['autocompletes' => $autoCompleteField],
2214           'ids' => ['profile' => $profiles],
2215         ]);
2216     }
2217   }
2218
2219   /**
2220    */
2221   public function canUseAjaxContactLookups() {
2222     if (0 < (civicrm_api3('contact', 'getcount', ['check_permissions' => 1])) &&
2223       CRM_Core_Permission::check([['access AJAX API', 'access CiviCRM']])
2224     ) {
2225       return TRUE;
2226     }
2227   }
2228
2229   /**
2230    * Add the options appropriate to cid = zero - ie. autocomplete
2231    *
2232    * @todo there is considerable code duplication between the contribution forms & event forms. It is apparent
2233    * that small pieces of duplication are not being refactored into separate functions because their only shared parent
2234    * is this form. Inserting a class FrontEndForm.php between the contribution & event & this class would allow functions like this
2235    * and a dozen other small ones to be refactored into a shared parent with the reduction of much code duplication
2236    */
2237   public function addCIDZeroOptions() {
2238     $this->assign('nocid', TRUE);
2239     $profiles = [];
2240     if ($this->_values['custom_pre_id']) {
2241       $profiles[] = $this->_values['custom_pre_id'];
2242     }
2243     if ($this->_values['custom_post_id']) {
2244       $profiles = array_merge($profiles, (array) $this->_values['custom_post_id']);
2245     }
2246     $profiles[] = 'billing';
2247     if (!empty($this->_values)) {
2248       $this->addAutoSelector($profiles);
2249     }
2250   }
2251
2252   /**
2253    * Set default values on form for given contact (or no contact defaults)
2254    *
2255    * @param mixed $profile_id
2256    *   (can be id, or profile name).
2257    * @param int $contactID
2258    *
2259    * @return array
2260    */
2261   public function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) {
2262     try {
2263       $defaults = civicrm_api3('profile', 'getsingle', [
2264         'profile_id' => (array) $profile_id,
2265         'contact_id' => $contactID,
2266       ]);
2267       return $defaults;
2268     }
2269     catch (Exception $e) {
2270       // the try catch block gives us silent failure -not 100% sure this is a good idea
2271       // as silent failures are often worse than noisy ones
2272       return [];
2273     }
2274   }
2275
2276   /**
2277    * Sets form attribute.
2278    * @see CRM.loadForm
2279    */
2280   public function preventAjaxSubmit() {
2281     $this->setAttribute('data-no-ajax-submit', 'true');
2282   }
2283
2284   /**
2285    * Sets form attribute.
2286    * @see CRM.loadForm
2287    */
2288   public function allowAjaxSubmit() {
2289     $this->removeAttribute('data-no-ajax-submit');
2290   }
2291
2292   /**
2293    * Sets page title based on entity and action.
2294    * @param string $entityLabel
2295    */
2296   public function setPageTitle($entityLabel) {
2297     switch ($this->_action) {
2298       case CRM_Core_Action::ADD:
2299         CRM_Utils_System::setTitle(ts('New %1', [1 => $entityLabel]));
2300         break;
2301
2302       case CRM_Core_Action::UPDATE:
2303         CRM_Utils_System::setTitle(ts('Edit %1', [1 => $entityLabel]));
2304         break;
2305
2306       case CRM_Core_Action::VIEW:
2307       case CRM_Core_Action::PREVIEW:
2308         CRM_Utils_System::setTitle(ts('View %1', [1 => $entityLabel]));
2309         break;
2310
2311       case CRM_Core_Action::DELETE:
2312         CRM_Utils_System::setTitle(ts('Delete %1', [1 => $entityLabel]));
2313         break;
2314     }
2315   }
2316
2317   /**
2318    * Create a chain-select target field. All settings are optional; the defaults usually work.
2319    *
2320    * @param string $elementName
2321    * @param array $settings
2322    *
2323    * @return HTML_QuickForm_Element
2324    */
2325   public function addChainSelect($elementName, $settings = []) {
2326     $props = $settings += [
2327       'control_field' => str_replace(['state_province', 'StateProvince', 'county', 'County'], [
2328         'country',
2329         'Country',
2330         'state_province',
2331         'StateProvince',
2332       ], $elementName),
2333       'data-callback' => strpos($elementName, 'rovince') ? 'civicrm/ajax/jqState' : 'civicrm/ajax/jqCounty',
2334       'label' => strpos($elementName, 'rovince') ? ts('State/Province') : ts('County'),
2335       'data-empty-prompt' => strpos($elementName, 'rovince') ? ts('Choose country first') : ts('Choose state first'),
2336       'data-none-prompt' => ts('- N/A -'),
2337       'multiple' => FALSE,
2338       'required' => FALSE,
2339       'placeholder' => empty($settings['required']) ? ts('- none -') : ts('- select -'),
2340     ];
2341     CRM_Utils_Array::remove($props, 'label', 'required', 'control_field', 'context');
2342     $props['class'] = (empty($props['class']) ? '' : "{$props['class']} ") . 'crm-select2';
2343     $props['data-select-prompt'] = $props['placeholder'];
2344     $props['data-name'] = $elementName;
2345
2346     $this->_chainSelectFields[$settings['control_field']] = $elementName;
2347
2348     // Passing NULL instead of an array of options
2349     // CRM-15225 - normally QF will reject any selected values that are not part of the field's options, but due to a
2350     // quirk in our patched version of HTML_QuickForm_select, this doesn't happen if the options are NULL
2351     // which seems a bit dirty but it allows our dynamically-popuplated select element to function as expected.
2352     return $this->add('select', $elementName, $settings['label'], NULL, $settings['required'], $props);
2353   }
2354
2355   /**
2356    * Add actions menu to results form.
2357    *
2358    * @param array $tasks
2359    */
2360   public function addTaskMenu($tasks) {
2361     if (is_array($tasks) && !empty($tasks)) {
2362       // Set constants means this will always load with an empty value, not reloading any submitted value.
2363       // This is appropriate as it is a pseudofield.
2364       $this->setConstants(['task' => '']);
2365       $this->assign('taskMetaData', $tasks);
2366       $select = $this->add('select', 'task', NULL, ['' => ts('Actions')], FALSE, [
2367         'class' => 'crm-select2 crm-action-menu fa-check-circle-o huge crm-search-result-actions',
2368       ]
2369       );
2370       foreach ($tasks as $key => $task) {
2371         $attributes = [];
2372         if (isset($task['data'])) {
2373           foreach ($task['data'] as $dataKey => $dataValue) {
2374             $attributes['data-' . $dataKey] = $dataValue;
2375           }
2376         }
2377         $select->addOption($task['title'], $key, $attributes);
2378       }
2379       if (empty($this->_actionButtonName)) {
2380         $this->_actionButtonName = $this->getButtonName('next', 'action');
2381       }
2382       $this->assign('actionButtonName', $this->_actionButtonName);
2383       $this->add('submit', $this->_actionButtonName, ts('Go'), ['class' => 'hiddenElement crm-search-go-button']);
2384
2385       // Radio to choose "All items" or "Selected items only"
2386       $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', ['checked' => 'checked']);
2387       $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
2388       $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']);
2389       $this->assign('ts_all_id', $allRowsRadio->_attributes['id']);
2390
2391       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header');
2392     }
2393   }
2394
2395   /**
2396    * Set options and attributes for chain select fields based on the controlling field's value
2397    */
2398   private function preProcessChainSelectFields() {
2399     foreach ($this->_chainSelectFields as $control => $target) {
2400       // The 'target' might get missing if extensions do removeElement() in a form hook.
2401       if ($this->elementExists($target)) {
2402         $targetField = $this->getElement($target);
2403         $targetType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ? 'county' : 'stateProvince';
2404         $options = [];
2405         // If the control field is on the form, setup chain-select and dynamically populate options
2406         if ($this->elementExists($control)) {
2407           $controlField = $this->getElement($control);
2408           $controlType = $targetType == 'county' ? 'stateProvince' : 'country';
2409
2410           $targetField->setAttribute('class', $targetField->getAttribute('class') . ' crm-chain-select-target');
2411
2412           $css = (string) $controlField->getAttribute('class');
2413           $controlField->updateAttributes([
2414             'class' => ($css ? "$css " : 'crm-select2 ') . 'crm-chain-select-control',
2415             'data-target' => $target,
2416           ]);
2417           $controlValue = $controlField->getValue();
2418           if ($controlValue) {
2419             $options = CRM_Core_BAO_Location::getChainSelectValues($controlValue, $controlType, TRUE);
2420             if (!$options) {
2421               $targetField->setAttribute('placeholder', $targetField->getAttribute('data-none-prompt'));
2422             }
2423           }
2424           else {
2425             $targetField->setAttribute('placeholder', $targetField->getAttribute('data-empty-prompt'));
2426             $targetField->setAttribute('disabled', 'disabled');
2427           }
2428         }
2429         // Control field not present - fall back to loading default options
2430         else {
2431           $options = CRM_Core_PseudoConstant::$targetType();
2432         }
2433         if (!$targetField->getAttribute('multiple')) {
2434           $options = ['' => $targetField->getAttribute('placeholder')] + $options;
2435           $targetField->removeAttribute('placeholder');
2436         }
2437         $targetField->_options = [];
2438         $targetField->loadArray($options);
2439       }
2440     }
2441   }
2442
2443   /**
2444    * Validate country / state / county match and suppress unwanted "required" errors
2445    */
2446   private function validateChainSelectFields() {
2447     foreach ($this->_chainSelectFields as $control => $target) {
2448       if ($this->elementExists($control) && $this->elementExists($target)) {
2449         $controlValue = (array) $this->getElementValue($control);
2450         $targetField = $this->getElement($target);
2451         $controlType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ? 'stateProvince' : 'country';
2452         $targetValue = array_filter((array) $targetField->getValue());
2453         if ($targetValue || $this->getElementError($target)) {
2454           $options = CRM_Core_BAO_Location::getChainSelectValues($controlValue, $controlType, TRUE);
2455           if ($targetValue) {
2456             if (!array_intersect($targetValue, array_keys($options))) {
2457               $this->setElementError($target, $controlType == 'country' ? ts('State/Province does not match the selected Country') : ts('County does not match the selected State/Province'));
2458             }
2459           }
2460           // Suppress "required" error for field if it has no options
2461           elseif (!$options) {
2462             $this->setElementError($target, NULL);
2463           }
2464         }
2465       }
2466     }
2467   }
2468
2469   /**
2470    * Assign billing name to the template.
2471    *
2472    * @param array $params
2473    *   Form input params, default to $this->_params.
2474    *
2475    * @return string
2476    */
2477   public function assignBillingName($params = []) {
2478     $name = '';
2479     if (empty($params)) {
2480       $params = $this->_params;
2481     }
2482     if (!empty($params['billing_first_name'])) {
2483       $name = $params['billing_first_name'];
2484     }
2485
2486     if (!empty($params['billing_middle_name'])) {
2487       $name .= " {$params['billing_middle_name']}";
2488     }
2489
2490     if (!empty($params['billing_last_name'])) {
2491       $name .= " {$params['billing_last_name']}";
2492     }
2493     $name = trim($name);
2494     $this->assign('billingName', $name);
2495     return $name;
2496   }
2497
2498   /**
2499    * Get the currency for the form.
2500    *
2501    * @todo this should be overriden on the forms rather than having this
2502    * historic, possible handling in here. As we clean that up we should
2503    * add deprecation notices into here.
2504    *
2505    * @param array $submittedValues
2506    *   Array allowed so forms inheriting this class do not break.
2507    *   Ideally we would make a clear standard around how submitted values
2508    *   are stored (is $this->_values consistently doing that?).
2509    *
2510    * @return string
2511    */
2512   public function getCurrency($submittedValues = []) {
2513     $currency = CRM_Utils_Array::value('currency', $this->_values);
2514     // For event forms, currency is in a different spot
2515     if (empty($currency)) {
2516       $currency = CRM_Utils_Array::value('currency', CRM_Utils_Array::value('event', $this->_values));
2517     }
2518     if (empty($currency)) {
2519       $currency = CRM_Utils_Request::retrieveValue('currency', 'String');
2520     }
2521     // @todo If empty there is a problem - we should probably put in a deprecation notice
2522     // to warn if that seems to be happening.
2523     return $currency;
2524   }
2525
2526   /**
2527    * Is the form in view or edit mode.
2528    *
2529    * The 'addField' function relies on the form action being one of a set list
2530    * of actions. Checking for these allows for an early return.
2531    *
2532    * @return bool
2533    */
2534   protected function isFormInViewOrEditMode() {
2535     return in_array($this->_action, [
2536       CRM_Core_Action::UPDATE,
2537       CRM_Core_Action::ADD,
2538       CRM_Core_Action::VIEW,
2539       CRM_Core_Action::BROWSE,
2540       CRM_Core_Action::BASIC,
2541       CRM_Core_Action::ADVANCED,
2542       CRM_Core_Action::PREVIEW,
2543     ]);
2544   }
2545
2546 }