3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
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
18 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 require_once 'HTML/QuickForm/Page.php';
26 class CRM_Core_Form
extends HTML_QuickForm_Page
{
29 * The state object that this form belongs to
35 * The name of this form
41 * The title of this form
44 protected $_title = NULL;
47 * The default values for the form.
51 public $_defaults = [];
54 * (QUASI-PROTECTED) The options passed into this form
56 * This field should marked `protected` and is not generally
57 * intended for external callers, but some edge-cases do use it.
61 public $_options = NULL;
64 * (QUASI-PROTECTED) The mode of operation for this form
66 * This field should marked `protected` and is not generally
67 * intended for external callers, but some edge-cases do use it.
74 * Available payment processors.
76 * As part of trying to consolidate various payment pages we store processors here & have functions
77 * at this level to manage them.
80 * An array of payment processor details with objects loaded in the 'object' field.
82 protected $_paymentProcessors;
85 * Available payment processors (IDS).
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.
92 * An array of the IDS available on this form.
94 public $_paymentProcessorIDs;
97 * Default or selected processor id.
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.
105 protected $_paymentProcessorID;
108 * Is pay later enabled for the form.
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.
116 protected $_is_pay_later_enabled;
119 * The renderer used for this form
123 protected $_renderer;
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
131 * e.g on a form declare $_dateFields = array(
132 * 'receive_date' => array('default' => 'now'),
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
138 protected $_dateFields = [];
141 * Cache the smarty template for efficiency reasons
143 * @var CRM_Core_Smarty
145 static protected $_template;
148 * Indicate if this form should warn users of unsaved changes
151 protected $unsavedChangesWarn;
154 * What to return to the client if in ajax mode (snippet=json)
158 public $ajaxResponse = [];
161 * Url path used to reach this page
165 public $urlPath = [];
168 * Context of the form being loaded.
179 public $submitOnce = FALSE;
182 * Values submitted by the user.
184 * These values have been checked for injection per
185 * https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php
186 * and are as submitted.
188 * Once set this array should be treated as read only.
192 protected $exportedValues = [];
197 public function getContext() {
198 return $this->context
;
202 * Set context variable.
204 public function setContext() {
205 $this->context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
209 * @var CRM_Core_Controller
214 * Constants for attributes for various form elements
215 * attempt to standardize on the number of variations that we
216 * use of the below form elements
220 const ATTR_SPACING
= ' ';
223 * All checkboxes are defined with a common prefix. This allows us to
224 * have the same javascript to check / clear all the checkboxes etc
225 * If u have multiple groups of checkboxes, you will need to give them different
226 * ids to avoid potential name collision
230 const CB_PREFIX
= 'mark_x_', CB_PREFIY
= 'mark_y_', CB_PREFIZ
= 'mark_z_', CB_PREFIX_LEN
= 7;
234 * @internal to keep track of chain-select fields
236 private $_chainSelectFields = [];
239 * Extra input types we support via the "add" method
242 public static $html5Types = [
250 * Constructor for the basic form page.
252 * We should not use QuickForm directly. This class provides a lot
253 * of default convenient functions, rules and buttons
255 * @param object $state
256 * State associated with this form.
257 * @param \const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete)
258 * @param string $method
259 * The type of http method used (GET/POST).
260 * @param string $name
261 * The name of the form if different from class name.
263 * @return \CRM_Core_Form
265 public function __construct(
267 $action = CRM_Core_Action
::NONE
,
273 $this->_name
= $name;
276 // CRM-15153 - FIXME this name translates to a DOM id and is not always unique!
277 $this->_name
= CRM_Utils_String
::getClassName(CRM_Utils_System
::getClassName($this));
280 parent
::__construct($this->_name
, $method);
282 $this->_state
=& $state;
284 $this->_state
->setName($this->_name
);
286 $this->_action
= (int) $action;
288 $this->registerRules();
290 // let the constructor initialize this, should happen only once
291 if (!isset(self
::$_template)) {
292 self
::$_template = CRM_Core_Smarty
::singleton();
294 // Workaround for CRM-15153 - give each form a reasonably unique css class
295 $this->addClass(CRM_Utils_System
::getClassName($this));
297 $this->assign('snippet', CRM_Utils_Array
::value('snippet', $_GET));
298 $this->setTranslatedFields();
302 * Set translated fields.
304 * This function is called from the class constructor, allowing us to set
305 * fields on the class that can't be set as properties due to need for
306 * translation or other non-input specific handling.
308 protected function setTranslatedFields() {}
311 * Add one or more css classes to the form.
313 * @param string $className
315 public function addClass($className) {
316 $classes = $this->getAttribute('class');
317 $this->setAttribute('class', ($classes ?
"$classes " : '') . $className);
321 * Register all the standard rules that most forms potentially use.
323 public function registerRules() {
353 foreach ($rules as $rule) {
354 $this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule');
359 * Simple easy to use wrapper around addElement.
361 * Deal with simple validation rules.
363 * @param string $type
364 * @param string $name
365 * @param string $label
366 * @param array $attributes (options for select elements)
367 * @param bool $required
368 * @param array $extra
369 * (attributes for select elements).
370 * For datepicker elements this is consistent with the data
371 * from CRM_Utils_Date::getDatePickerExtra
373 * @return HTML_QuickForm_Element
374 * Could be an error object
376 * @throws \CRM_Core_Exception
378 public function &add(
379 $type, $name, $label = '',
380 $attributes = NULL, $required = FALSE, $extra = NULL
382 if ($type === 'radio') {
383 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_Form::addRadio');
386 if ($type !== 'static' && $attributes && !is_array($attributes)) {
387 // The $attributes param used to allow for strings and would default to an
388 // empty string. However, now that the variable is heavily manipulated,
389 // we should expect it to always be an array.
390 CRM_Core_Error
::deprecatedWarning('Attributes passed to CRM_Core_Form::add() are not an array.');
392 // Fudge some extra types that quickform doesn't support
394 if ($type == 'wysiwyg' ||
in_array($type, self
::$html5Types)) {
395 $attributes = ($attributes ?
$attributes : []) +
['class' => ''];
396 $attributes['class'] = ltrim($attributes['class'] . " crm-form-$type");
397 if ($type == 'wysiwyg' && isset($attributes['preset'])) {
398 $attributes['data-preset'] = $attributes['preset'];
399 unset($attributes['preset']);
401 $type = $type == 'wysiwyg' ?
'textarea' : 'text';
403 // Like select but accepts rich array data (with nesting, colors, icons, etc) as option list.
404 if ($inputType == 'select2') {
406 $options = $attributes;
407 $attributes = ($extra ?
$extra : []) +
['class' => ''];
408 $attributes['class'] = ltrim($attributes['class'] . " crm-select2 crm-form-select2");
409 $attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]);
410 unset($attributes['multiple']);
414 // @see https://docs.civicrm.org/dev/en/latest/framework/ui/#date-picker
415 if ($type === 'datepicker') {
416 $attributes = $attributes ?
: [];
417 if (!empty($attributes['formatType'])) {
418 $dateAttributes = CRM_Core_SelectValues
::date($attributes['formatType'], NULL, NULL, NULL, 'Input');
419 if (empty($extra['minDate']) && !empty($dateAttributes['minYear'])) {
420 $extra['minDate'] = $dateAttributes['minYear'] . '-01-01';
422 if (empty($extra['maxDate']) && !empty($dateAttributes['minYear'])) {
423 $extra['maxDate'] = $dateAttributes['maxYear'] . '-12-31';
426 // Support minDate/maxDate properties
427 if (isset($extra['minDate'])) {
428 $extra['minDate'] = date('Y-m-d', strtotime($extra['minDate']));
430 if (isset($extra['maxDate'])) {
431 $extra['maxDate'] = date('Y-m-d', strtotime($extra['maxDate']));
434 $attributes['data-crm-datepicker'] = json_encode((array) $extra);
435 if (!empty($attributes['aria-label']) ||
$label) {
436 $attributes['aria-label'] = $attributes['aria-label'] ??
$label;
440 if ($type === 'select' && is_array($extra)) {
441 // Normalize this property
442 if (!empty($extra['multiple'])) {
443 $extra['multiple'] = 'multiple';
446 unset($extra['multiple']);
448 unset($extra['size'], $extra['maxlength']);
449 // Add placeholder option for select
450 if (isset($extra['placeholder'])) {
451 if ($extra['placeholder'] === TRUE) {
452 $extra['placeholder'] = ts('- select %1 -', [1 => $label]);
454 if (($extra['placeholder'] ||
$extra['placeholder'] === '') && empty($extra['multiple']) && is_array($attributes) && !isset($attributes[''])) {
455 $attributes = ['' => $extra['placeholder']] +
$attributes;
459 $optionContext = NULL;
460 if (!empty($extra['option_context'])) {
461 $optionContext = $extra['option_context'];
462 unset($extra['option_context']);
465 $element = $this->addElement($type, $name, CRM_Utils_String
::purifyHTML($label), $attributes, $extra);
466 if (HTML_QuickForm
::isError($element)) {
467 CRM_Core_Error
::statusBounce(HTML_QuickForm
::errorMessage($element));
470 if ($inputType == 'color') {
471 $this->addRule($name, ts('%1 must contain a color value e.g. #ffffff.', [1 => $label]), 'regex', '/#[0-9a-fA-F]{6}/');
475 if ($type == 'file') {
476 $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'uploadedfile');
479 $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'required');
481 if (HTML_QuickForm
::isError($error)) {
482 CRM_Core_Error
::statusBounce(HTML_QuickForm
::errorMessage($element));
486 // Add context for the editing of option groups
487 if ($optionContext) {
488 $element->setAttribute('data-option-edit-context', json_encode($optionContext));
497 * This is called before buildForm. Any pre-processing that
498 * needs to be done for buildForm should be done here.
500 * This is a virtual function and should be redefined if needed.
502 public function preProcess() {
506 * Called after the form is validated.
508 * Any processing of form state etc should be done in this function.
509 * Typically all processing associated with a form should be done
510 * here and relevant state should be stored in the session
512 * This is a virtual function and should be redefined if needed
514 public function postProcess() {
518 * Main process wrapper.
520 * Implemented so that we can call all the hook functions.
522 * @param bool $allowAjax
523 * FIXME: This feels kind of hackish, ideally we would take the json-related code from this function.
524 * and bury it deeper down in the controller
526 public function mainProcess($allowAjax = TRUE) {
527 $this->postProcess();
528 $this->postProcessHook();
530 // Respond with JSON if in AJAX context (also support legacy value '6')
531 if ($allowAjax && !empty($_REQUEST['snippet']) && in_array($_REQUEST['snippet'], [
532 CRM_Core_Smarty
::PRINT_JSON
,
535 $this->ajaxResponse
['buttonName'] = str_replace('_qf_' . $this->getAttribute('id') . '_', '', $this->controller
->getButtonName());
536 $this->ajaxResponse
['action'] = $this->_action
;
537 if (isset($this->_id
) ||
isset($this->id
)) {
538 $this->ajaxResponse
['id'] = $this->id ??
$this->_id
;
540 CRM_Core_Page_AJAX
::returnJsonResponse($this->ajaxResponse
);
545 * The postProcess hook is typically called by the framework.
547 * However in a few cases, the form exits or redirects early in which
548 * case it needs to call this function so other modules can do the needful
549 * Calling this function directly should be avoided if possible. In general a
550 * better way is to do setUserContext so the framework does the redirect
552 public function postProcessHook() {
553 CRM_Utils_Hook
::postProcess(get_class($this), $this);
557 * This virtual function is used to build the form.
559 * It replaces the buildForm associated with QuickForm_Page. This allows us to put
560 * preProcess in front of the actual form building routine
562 public function buildQuickForm() {
566 * This virtual function is used to set the default values of various form elements.
569 * reference to the array of default values
571 public function setDefaultValues() {
576 * This is a virtual function that adds group and global rules to the form.
578 * Keeping it distinct from the form to keep code small
579 * and localized in the form building code
581 public function addRules() {
585 * Performs the server side validation.
588 * true if no error found
589 * @throws HTML_QuickForm_Error
591 public function validate() {
592 $error = parent
::validate();
594 $this->validateChainSelectFields();
598 CRM_Utils_Hook
::validateForm(
600 $this->_submitValues
,
606 if (!empty($hookErrors)) {
607 $this->_errors +
= $hookErrors;
610 return (0 == count($this->_errors
));
614 * Core function that builds the form.
616 * We redefine this function here and expect all CRM forms to build their form in the function
619 public function buildForm() {
620 $this->_formBuilt
= TRUE;
624 CRM_Utils_Hook
::preProcess(get_class($this), $this);
626 $this->assign('translatePermission', CRM_Core_Permission
::check('translate CiviCRM'));
629 $this->controller
->_key
&&
630 $this->controller
->_generateQFKey
632 $this->addElement('hidden', 'qfKey', $this->controller
->_key
);
633 $this->assign('qfKey', $this->controller
->_key
);
637 // _generateQFKey suppresses the qfKey generation on form snippets that
638 // are part of other forms, hence we use that to avoid adding entryURL
639 if ($this->controller
->_generateQFKey
&& $this->controller
->_entryURL
) {
640 $this->addElement('hidden', 'entryURL', $this->controller
->_entryURL
);
643 $this->buildQuickForm();
645 $defaults = $this->setDefaultValues();
646 unset($defaults['qfKey']);
648 if (!empty($defaults)) {
649 $this->setDefaults($defaults);
652 // call the form hook
653 // also call the hook function so any modules can set their own custom defaults
654 // the user can do both the form and set default values with this hook
655 CRM_Utils_Hook
::buildForm(get_class($this), $this);
659 //Set html data-attribute to enable warning user of unsaved changes
660 if ($this->unsavedChangesWarn
=== TRUE
661 ||
(!isset($this->unsavedChangesWarn
)
662 && ($this->_action
& CRM_Core_Action
::ADD ||
$this->_action
& CRM_Core_Action
::UPDATE
)
665 $this->setAttribute('data-warn-changes', 'true');
668 if ($this->submitOnce
) {
669 $this->setAttribute('data-submit-once', 'true');
674 * Add default Next / Back buttons.
676 * @param array $params
677 * Array of associative arrays in the order in which the buttons should be
678 * displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault'
679 * The base form class will define a bunch of static arrays for commonly used
682 public function addButtons($params) {
683 $prevnext = $spacing = [];
684 foreach ($params as $button) {
685 if (!empty($button['submitOnce'])) {
686 $this->submitOnce
= TRUE;
689 $attrs = ['class' => 'crm-form-submit'] +
(array) CRM_Utils_Array
::value('js', $button);
691 // A lot of forms use the hacky method of looking at
692 // `$params['button name']` (dating back to them being inputs with a
693 // "value" of the button label) rather than looking at
694 // `$this->controller->getButtonName()`. It makes sense to give buttons a
695 // value by default as a precaution.
698 if (!empty($button['class'])) {
699 $attrs['class'] .= ' ' . $button['class'];
702 if (!empty($button['isDefault'])) {
703 $attrs['class'] .= ' default';
706 if (in_array($button['type'], ['upload', 'next', 'submit', 'done', 'process', 'refresh'])) {
707 $attrs['class'] .= ' validate';
708 $defaultIcon = 'fa-check';
711 $attrs['class'] .= ' cancel';
712 $defaultIcon = $button['type'] == 'back' ?
'fa-chevron-left' : 'fa-times';
715 if ($button['type'] === 'reset') {
716 $attrs['type'] = 'reset';
717 $prevnext[] = $this->createElement('xbutton', 'reset', $button['name'], $attrs);
720 if (!empty($button['subName'])) {
721 if ($button['subName'] == 'new') {
722 $defaultIcon = 'fa-plus-circle';
724 if ($button['subName'] == 'done') {
725 $defaultIcon = 'fa-check-circle';
727 if ($button['subName'] == 'next') {
728 $defaultIcon = 'fa-chevron-right';
732 if (in_array($button['type'], ['next', 'upload', 'done']) && $button['name'] === ts('Save')) {
733 $attrs['accesskey'] = 'S';
735 $buttonContents = CRM_Core_Page
::crmIcon($button['icon'] ??
$defaultIcon) . ' ' . $button['name'];
736 $buttonName = $this->getButtonName($button['type'], CRM_Utils_Array
::value('subName', $button));
737 $attrs['class'] .= " crm-button crm-button-type-{$button['type']} crm-button{$buttonName}";
738 $attrs['type'] = 'submit';
739 $prevnext[] = $this->createElement('xbutton', $buttonName, $buttonContents, $attrs);
741 if (!empty($button['isDefault'])) {
742 $this->setDefaultAction($button['type']);
745 // if button type is upload, set the enctype
746 if ($button['type'] == 'upload') {
747 $this->updateAttributes(['enctype' => 'multipart/form-data']);
748 $this->setMaxFileSize();
751 // hack - addGroup uses an array to express variable spacing, read from the last element
752 $spacing[] = CRM_Utils_Array
::value('spacing', $button, self
::ATTR_SPACING
);
754 $this->addGroup($prevnext, 'buttons', '', $spacing, FALSE);
758 * Getter function for Name.
762 public function getName() {
767 * Getter function for State.
771 public function &getState() {
772 return $this->_state
;
776 * Getter function for StateType.
780 public function getStateType() {
781 return $this->_state
->getType();
785 * Getter function for title.
787 * Should be over-ridden by derived class.
791 public function getTitle() {
792 return $this->_title ?
$this->_title
: ts('ERROR: Title is not Set');
796 * Setter function for title.
798 * @param string $title
799 * The title of the form.
801 public function setTitle($title) {
802 $this->_title
= $title;
803 CRM_Utils_System
::setTitle($title);
807 * Assign billing type id to bltID.
809 * @throws CRM_Core_Exception
811 public function assignBillingType() {
812 $this->_bltID
= CRM_Core_BAO_LocationType
::getBilling();
813 $this->set('bltID', $this->_bltID
);
814 $this->assign('bltID', $this->_bltID
);
820 public function getPaymentProcessorID(): int {
821 return (int) $this->_paymentProcessorID
;
825 * This if a front end form function for setting the payment processor.
827 * It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.
829 * @param bool $isPayLaterEnabled
831 * @throws \CRM_Core_Exception
833 protected function assignPaymentProcessor($isPayLaterEnabled) {
834 $this->_paymentProcessors
= CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessors([ucfirst($this->_mode
) . 'Mode'], $this->_paymentProcessorIDs
);
835 if ($isPayLaterEnabled) {
836 $this->_paymentProcessors
[0] = CRM_Financial_BAO_PaymentProcessor
::getPayment(0);
839 if (!empty($this->_paymentProcessors
)) {
840 foreach ($this->_paymentProcessors
as $paymentProcessorID => $paymentProcessorDetail) {
841 if (empty($this->_paymentProcessor
) && $paymentProcessorDetail['is_default'] == 1 ||
(count($this->_paymentProcessors
) == 1)
843 $this->_paymentProcessor
= $paymentProcessorDetail;
844 $this->assign('paymentProcessor', $this->_paymentProcessor
);
845 // Setting this is a bit of a legacy overhang.
846 $this->_paymentObject
= $paymentProcessorDetail['object'];
849 // It's not clear why we set this on the form.
850 $this->set('paymentProcessors', $this->_paymentProcessors
);
855 * Assign an array of variables to the form/tpl
857 * @param array $values Array of [key => value] to assign to the form
858 * @param array $keys Array of keys to assign from the values array
860 public function assignVariables($values, $keys) {
861 foreach ($keys as $key) {
862 $this->assign($key, $values[$key] ??
NULL);
867 * Format the fields in $this->_params for the payment processor.
869 * In order to pass fields to the payment processor in a consistent way we add some renamed
872 * @param array $fields
876 protected function formatParamsForPaymentProcessor($fields) {
877 $this->_params
= $this->prepareParamsForPaymentProcessor($this->_params
);
878 $fields = array_merge($fields, ['first_name' => 1, 'middle_name' => 1, 'last_name' => 1]);
883 * Format the fields in $params for the payment processor.
885 * In order to pass fields to the payment processor in a consistent way we add some renamed
888 * @param array $params Payment processor params
890 * @return array $params
892 protected function prepareParamsForPaymentProcessor($params) {
893 // also add location name to the array
894 $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);
895 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
896 // Add additional parameters that the payment processors are used to receiving.
897 if (!empty($params["billing_state_province_id-{$this->_bltID}"])) {
898 $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}"]);
900 if (!empty($params["billing_country_id-{$this->_bltID}"])) {
901 $params['country'] = $params["country-{$this->_bltID}"] = $params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($params["billing_country_id-{$this->_bltID}"]);
904 list($hasAddressField, $addressParams) = CRM_Contribute_BAO_Contribution
::getPaymentProcessorReadyAddressParams($params, $this->_bltID
);
905 if ($hasAddressField) {
906 $params = array_merge($params, $addressParams);
909 // How does this relate to similar code in CRM_Contact_BAO_Contact::addBillingNameFieldsIfOtherwiseNotSet()?
910 $nameFields = ['first_name', 'middle_name', 'last_name'];
911 foreach ($nameFields as $name) {
912 if (array_key_exists("billing_$name", $params)) {
913 $params[$name] = $params["billing_{$name}"];
914 $params['preserveDBName'] = TRUE;
918 // For legacy reasons we set these creditcard expiry fields if present
919 CRM_Contribute_Form_AbstractEditPayment
::formatCreditCardDetails($params);
921 // Assign IP address parameter
922 $params['ip_address'] = CRM_Utils_System
::ipAddress();
928 * Handle Payment Processor switching for contribution and event registration forms.
930 * This function is shared between contribution & event forms & this is their common class.
932 * However, this should be seen as an in-progress refactor, the end goal being to also align the
933 * backoffice forms that action payments.
935 * This function overlaps assignPaymentProcessor, in a bad way.
937 protected function preProcessPaymentOptions() {
938 $this->_paymentProcessorID
= NULL;
939 if ($this->_paymentProcessors
) {
940 if (!empty($this->_submitValues
)) {
941 $this->_paymentProcessorID
= $this->_submitValues
['payment_processor_id'] ??
NULL;
942 $this->_paymentProcessor
= $this->_paymentProcessors
[$this->_paymentProcessorID
] ??
NULL;
943 $this->set('type', $this->_paymentProcessorID
);
944 $this->set('mode', $this->_mode
);
945 $this->set('paymentProcessor', $this->_paymentProcessor
);
947 // Set default payment processor
949 foreach ($this->_paymentProcessors
as $values) {
950 if (!empty($values['is_default']) ||
count($this->_paymentProcessors
) == 1) {
951 $this->_paymentProcessorID
= $values['id'];
956 if ($this->_paymentProcessorID
957 ||
(isset($this->_submitValues
['payment_processor_id']) && $this->_submitValues
['payment_processor_id'] == 0)
959 CRM_Core_Payment_ProcessorForm
::preProcess($this);
962 $this->_paymentProcessor
= [];
966 // We save the fact that the profile 'billing' is required on the payment form.
967 // Currently pay-later is the only 'processor' that takes notice of this - but ideally
968 // 1) it would be possible to select the minimum_billing_profile_id for the contribution form
969 // 2) that profile_id would be set on the payment processor
970 // 3) the payment processor would return a billing form that combines these user-configured
971 // minimums with the payment processor minimums. This would lead to fields like 'postal_code'
972 // only being on the form if either the admin has configured it as wanted or the processor
974 $this->assign('billing_profile_id', (!empty($this->_values
['is_billing_required']) ?
'billing' : ''));
978 * Handle pre approval for processors.
980 * This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.
982 * This function is shared between contribution & event forms & this is their common class.
984 * However, this should be seen as an in-progress refactor, the end goal being to also align the
985 * backoffice forms that action payments.
987 * @param array $params
989 protected function handlePreApproval(&$params) {
991 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
992 $params['component'] = $params['component'] ??
'contribute';
993 $result = $payment->doPreApproval($params);
994 if (empty($result)) {
995 // This could happen, for example, when paypal looks at the button value & decides it is not paypal express.
999 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
1000 CRM_Core_Error
::statusBounce(ts('Payment approval failed with message :') . $e->getMessage(), $payment->getCancelUrl($params['qfKey'], CRM_Utils_Array
::value('participant_id', $params)));
1003 $this->set('pre_approval_parameters', $result['pre_approval_parameters']);
1004 if (!empty($result['redirect_url'])) {
1005 CRM_Utils_System
::redirect($result['redirect_url']);
1010 * Setter function for options.
1012 * @param mixed $options
1014 public function setOptions($options) {
1015 $this->_options
= $options;
1019 * Render form and return contents.
1023 public function toSmarty() {
1024 $this->preProcessChainSelectFields();
1025 $renderer = $this->getRenderer();
1026 $this->accept($renderer);
1027 $content = $renderer->toArray();
1028 $content['formName'] = $this->getName();
1030 $content['formClass'] = CRM_Utils_System
::getClassName($this);
1035 * Getter function for renderer.
1037 * If renderer is not set create one and initialize it.
1041 public function &getRenderer() {
1042 if (!isset($this->_renderer
)) {
1043 $this->_renderer
= CRM_Core_Form_Renderer
::singleton();
1045 return $this->_renderer
;
1049 * Use the form name to create the tpl file name.
1053 public function getTemplateFileName() {
1054 $ext = CRM_Extension_System
::singleton()->getMapper();
1055 if ($ext->isExtensionClass(CRM_Utils_System
::getClassName($this))) {
1056 $filename = $ext->getTemplateName(CRM_Utils_System
::getClassName($this));
1057 $tplname = $ext->getTemplatePath(CRM_Utils_System
::getClassName($this)) . DIRECTORY_SEPARATOR
. $filename;
1061 CRM_Utils_System
::getClassName($this),
1063 '_' => DIRECTORY_SEPARATOR
,
1064 '\\' => DIRECTORY_SEPARATOR
,
1072 * A wrapper for getTemplateFileName.
1074 * This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
1076 public function getHookedTemplateFileName() {
1077 $pageTemplateFile = $this->getTemplateFileName();
1078 CRM_Utils_Hook
::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
1079 return $pageTemplateFile;
1083 * Default extra tpl file basically just replaces .tpl with .extra.tpl.
1085 * i.e. we do not override.
1089 public function overrideExtraTemplateFileName() {
1094 * Error reporting mechanism.
1096 * @param string $message
1100 * @param CRM_Core_DAO $dao
1101 * A data access object on which we perform a rollback if non - empty.
1103 public function error($message, $code = NULL, $dao = NULL) {
1105 $dao->query('ROLLBACK');
1108 $error = CRM_Core_Error
::singleton();
1110 $error->push($code, $message);
1114 * Store the variable with the value in the form scope.
1116 * @param string $name
1117 * Name of the variable.
1118 * @param mixed $value
1119 * Value of the variable.
1121 public function set($name, $value) {
1122 $this->controller
->set($name, $value);
1126 * Get the variable from the form scope.
1128 * @param string $name
1129 * Name of the variable
1133 public function get($name) {
1134 return $this->controller
->get($name);
1138 * Getter for action.
1142 public function getAction() {
1143 return $this->_action
;
1147 * Setter for action.
1149 * @param int $action
1150 * The mode we want to set the form.
1152 public function setAction($action) {
1153 $this->_action
= $action;
1157 * Assign value to name in template.
1159 * @param string $var
1161 * @param mixed $value
1162 * Value of variable.
1164 public function assign($var, $value = NULL) {
1165 self
::$_template->assign($var, $value);
1169 * Assign value to name in template by reference.
1171 * @param string $var
1173 * @param mixed $value
1174 * Value of variable.
1176 public function assign_by_ref($var, &$value) {
1177 self
::$_template->assign_by_ref($var, $value);
1181 * Appends values to template variables.
1183 * @param array|string $tpl_var the template variable name(s)
1184 * @param mixed $value
1185 * The value to append.
1186 * @param bool $merge
1188 public function append($tpl_var, $value = NULL, $merge = FALSE) {
1189 self
::$_template->append($tpl_var, $value, $merge);
1193 * Returns an array containing template variables.
1195 * @param string $name
1199 public function get_template_vars($name = NULL) {
1200 return self
::$_template->get_template_vars($name);
1204 * @param string $name
1207 * @param array $attributes
1208 * @param null $separator
1209 * @param bool $required
1210 * @param array $optionAttributes - Option specific attributes
1212 * @return HTML_QuickForm_group
1214 public function &addRadio($name, $title, $values, $attributes = [], $separator = NULL, $required = FALSE, $optionAttributes = []) {
1216 $attributes = $attributes ?
$attributes : [];
1217 $allowClear = !empty($attributes['allowClear']);
1218 unset($attributes['allowClear']);
1219 $attributes['id_suffix'] = $name;
1220 foreach ($values as $key => $var) {
1221 $optAttributes = $attributes;
1222 if (!empty($optionAttributes[$key])) {
1223 foreach ($optionAttributes[$key] as $optAttr => $optVal) {
1224 $optAttributes[$optAttr] = ltrim(($optAttributes[$optAttr] ??
'') . ' ' . $optVal);
1227 // We use a class here to avoid html5 issues with collapsed cutsomfield sets.
1228 $optAttributes['class'] = $optAttributes['class'] ??
'';
1230 $optAttributes['class'] .= ' required';
1232 $element = $this->createElement('radio', NULL, NULL, $var, $key, $optAttributes);
1233 $options[] = $element;
1235 $group = $this->addGroup($options, $name, $title, $separator);
1237 $optionEditKey = 'data-option-edit-path';
1238 if (!empty($attributes[$optionEditKey])) {
1239 $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1243 $this->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required');
1246 $group->setAttribute('allowClear', TRUE);
1254 * @param bool $allowClear
1255 * @param null $required
1256 * @param array $attributes
1258 public function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = []) {
1259 $attributes +
= ['id_suffix' => $id];
1261 $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes);
1262 $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes);
1264 $group = $this->addGroup($choice, $id, $title);
1266 $group->setAttribute('allowClear', TRUE);
1269 $this->addRule($id, ts('%1 is a required field.', [1 => $title]), 'required');
1277 * @param null $other
1278 * @param null $attributes
1279 * @param null $required
1280 * @param null $javascriptMethod
1281 * @param string $separator
1282 * @param bool $flipValues
1284 public function addCheckBox(
1285 $id, $title, $values, $other = NULL,
1286 $attributes = NULL, $required = NULL,
1287 $javascriptMethod = NULL,
1288 $separator = '<br />', $flipValues = FALSE
1292 if ($javascriptMethod) {
1293 foreach ($values as $key => $var) {
1295 $options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod, $attributes);
1298 $options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod, $attributes);
1303 foreach ($values as $key => $var) {
1305 $options[] = $this->createElement('checkbox', $var, NULL, $key, $attributes);
1308 $options[] = $this->createElement('checkbox', $key, NULL, $var, $attributes);
1313 $group = $this->addGroup($options, $id, $title, $separator);
1314 $optionEditKey = 'data-option-edit-path';
1315 if (!empty($attributes[$optionEditKey])) {
1316 $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1320 $this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']);
1325 ts('%1 is a required field.', [1 => $title]),
1331 public function resetValues() {
1332 $data = $this->controller
->container();
1333 $data['values'][$this->_name
] = [];
1337 * Simple shell that derived classes can call to add buttons to
1338 * the form with a customized title for the main Submit
1340 * @param string $title
1341 * Title of the main button.
1342 * @param string $nextType
1343 * Button type for the form after processing.
1344 * @param string $backType
1345 * @param bool|string $submitOnce
1347 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
1349 if ($backType != NULL) {
1351 'type' => $backType,
1352 'name' => ts('Previous'),
1355 if ($nextType != NULL) {
1357 'type' => $nextType,
1359 'isDefault' => TRUE,
1362 $this->submitOnce
= TRUE;
1364 $buttons[] = $nextButton;
1366 $this->addButtons($buttons);
1370 * @param string $name
1371 * @param string $from
1373 * @param string $label
1374 * @param string $dateFormat
1375 * @param bool $required
1376 * @param bool $displayTime
1378 public function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
1379 CRM_Core_Error
::deprecatedFunctionWarning('Use CRM_Core_Form::addDatePickerRange insted');
1381 $this->addDateTime($name . $from, $label, $required, ['formatType' => $dateFormat]);
1382 $this->addDateTime($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1385 $this->addDate($name . $from, $label, $required, ['formatType' => $dateFormat]);
1386 $this->addDate($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1391 * Add a search for a range using date picker fields.
1393 * @param string $fieldName
1394 * @param string $label
1395 * @param bool $isDateTime
1396 * Is this a date-time field (not just date).
1397 * @param bool $required
1398 * @param string $fromLabel
1399 * @param string $toLabel
1400 * @param array $additionalOptions
1401 * @param string $to string to append to the to field.
1402 * @param string $from string to append to the from field.
1404 public function addDatePickerRange($fieldName, $label, $isDateTime = FALSE, $required = FALSE, $fromLabel = 'From', $toLabel = 'To', $additionalOptions = [],
1405 $to = '_high', $from = '_low') {
1408 '' => ts('- any -'),
1409 0 => ts('Choose Date Range'),
1410 ] + CRM_Core_OptionGroup
::values('relative_date_filters');
1412 if ($additionalOptions) {
1413 foreach ($additionalOptions as $key => $optionLabel) {
1414 $options[$key] = $optionLabel;
1418 $this->add('select',
1419 "{$fieldName}_relative",
1423 ['class' => 'crm-select2']
1425 $attributes = ['formatType' => 'searchDate'];
1426 $extra = ['time' => $isDateTime];
1427 $this->add('datepicker', $fieldName . $from, ts($fromLabel), $attributes, $required, $extra);
1428 $this->add('datepicker', $fieldName . $to, ts($toLabel), $attributes, $required, $extra);
1432 * Based on form action, return a string representing the api action.
1433 * Used by addField method.
1437 protected function getApiAction() {
1438 $action = $this->getAction();
1439 if ($action & (CRM_Core_Action
::UPDATE + CRM_Core_Action
::ADD
)) {
1442 if ($action & (CRM_Core_Action
::VIEW + CRM_Core_Action
::BROWSE + CRM_Core_Action
::BASIC + CRM_Core_Action
::ADVANCED + CRM_Core_Action
::PREVIEW
)) {
1445 if ($action & (CRM_Core_Action
::DELETE
)) {
1448 // If you get this exception try adding more cases above.
1449 throw new Exception("Cannot determine api action for " . get_class($this) . '.' . 'CRM_Core_Action "' . CRM_Core_Action
::description($action) . '" not recognized.');
1453 * Classes extending CRM_Core_Form should implement this method.
1456 public function getDefaultEntity() {
1457 throw new Exception("Cannot determine default entity. " . get_class($this) . " should implement getDefaultEntity().");
1461 * Classes extending CRM_Core_Form should implement this method.
1463 * TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
1466 public function getDefaultContext() {
1467 throw new Exception("Cannot determine default context. " . get_class($this) . " should implement getDefaultContext().");
1471 * Adds a select based on field metadata.
1472 * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata
1473 * Perhaps a method like $form->bind($name) which would look up all metadata for named field
1475 * Field name to go on the form.
1476 * @param array $props
1477 * Mix of html attributes and special properties, namely.
1478 * - entity (api entity name, can usually be inferred automatically from the form class)
1479 * - field (field name - only needed if different from name used on the form)
1480 * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1481 * - placeholder - set to NULL to disable
1483 * - context - @see CRM_Core_DAO::buildOptionsContext
1484 * @param bool $required
1485 * @throws CRM_Core_Exception
1486 * @return HTML_QuickForm_Element
1488 public function addSelect($name, $props = [], $required = FALSE) {
1489 if (!isset($props['entity'])) {
1490 $props['entity'] = $this->getDefaultEntity();
1492 if (!isset($props['field'])) {
1493 $props['field'] = strrpos($name, '[') ?
rtrim(substr($name, 1 +
strrpos($name, '[')), ']') : $name;
1495 if (!isset($props['context'])) {
1497 $props['context'] = $this->getDefaultContext();
1499 // This is not a required param, so we'll ignore if this doesn't exist.
1500 catch (Exception
$e) {
1503 // Fetch options from the api unless passed explicitly
1504 if (isset($props['options'])) {
1505 $options = $props['options'];
1508 $info = civicrm_api3($props['entity'], 'getoptions', $props);
1509 $options = $info['values'];
1511 if (!array_key_exists('placeholder', $props) && $placeholder = self
::selectOrAnyPlaceholder($props, $required)) {
1512 $props['placeholder'] = $placeholder;
1514 // Handle custom field
1515 if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1516 list(, $id) = explode('_', $name);
1517 $label = $props['label'] ?? CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id);
1518 $gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id);
1519 if (CRM_Utils_Array
::value('context', $props) != 'search') {
1520 $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);
1525 $info = civicrm_api3($props['entity'], 'getfields');
1526 foreach ($info['values'] as $uniqueName => $fieldSpec) {
1528 $uniqueName === $props['field'] ||
1529 CRM_Utils_Array
::value('name', $fieldSpec) === $props['field'] ||
1530 in_array($props['field'], CRM_Utils_Array
::value('api.aliases', $fieldSpec, []))
1535 $label = $props['label'] ??
$fieldSpec['title'];
1536 if (CRM_Utils_Array
::value('context', $props) != 'search') {
1537 $props['data-option-edit-path'] = array_key_exists('option_url', $props) ?
$props['option_url'] : CRM_Core_PseudoConstant
::getOptionEditUrl($fieldSpec);
1540 $props['class'] = (isset($props['class']) ?
$props['class'] . ' ' : '') . "crm-select2";
1541 $props['data-api-entity'] = $props['entity'];
1542 $props['data-api-field'] = $props['field'];
1543 CRM_Utils_Array
::remove($props, 'label', 'entity', 'field', 'option_url', 'options', 'context');
1544 return $this->add('select', $name, $label, $options, $required, $props);
1548 * Handles a repeated bit supplying a placeholder for entity selection
1550 * @param string $props
1551 * The field properties, including the entity and context.
1552 * @param bool $required
1553 * If the field is required.
1554 * @param string $title
1555 * A field title, if applicable.
1557 * The placeholder text.
1559 private static function selectOrAnyPlaceholder($props, $required, $title = NULL) {
1560 if (empty($props['entity'])) {
1564 $daoToClass = CRM_Core_DAO_AllCoreTables
::daoToClass();
1565 if (array_key_exists($props['entity'], $daoToClass)) {
1566 $daoClass = $daoToClass[$props['entity']];
1567 $title = $daoClass::getEntityTitle();
1570 $title = ts('option');
1573 if (($props['context'] ??
'') == 'search' && !$required) {
1574 return ts('- any %1 -', [1 => $title]);
1576 return ts('- select %1 -', [1 => $title]);
1580 * Adds a field based on metadata.
1583 * Field name to go on the form.
1584 * @param array $props
1585 * Mix of html attributes and special properties, namely.
1586 * - entity (api entity name, can usually be inferred automatically from the form class)
1587 * - name (field name - only needed if different from name used on the form)
1588 * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1589 * - placeholder - set to NULL to disable
1591 * - context - @see CRM_Core_DAO::buildOptionsContext
1592 * @param bool $required
1593 * @param bool $legacyDate
1594 * Temporary param to facilitate the conversion of fields to use the datepicker in
1595 * a controlled way. To convert the field the jcalendar code needs to be removed from the
1596 * tpl as well. That file is intended to be EOL.
1598 * @throws \CiviCRM_API3_Exception
1599 * @throws \Exception
1601 * HTML_QuickForm_Element
1604 public function addField($name, $props = [], $required = FALSE, $legacyDate = TRUE) {
1606 if (empty($props['context'])) {
1607 $props['context'] = $this->getDefaultContext();
1609 $context = $props['context'];
1611 if (empty($props['entity'])) {
1612 $props['entity'] = $this->getDefaultEntity();
1615 if (empty($props['name'])) {
1616 $props['name'] = strrpos($name, '[') ?
rtrim(substr($name, 1 +
strrpos($name, '[')), ']') : $name;
1619 if (empty($props['action'])) {
1620 $props['action'] = $this->getApiAction();
1623 // Handle custom fields
1624 if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1625 $fieldId = (int) substr($name, 7);
1626 return CRM_Core_BAO_CustomField
::addQuickFormElement($this, $name, $fieldId, $required, $context == 'search', CRM_Utils_Array
::value('label', $props));
1629 // Core field - get metadata.
1630 $fieldSpec = civicrm_api3($props['entity'], 'getfield', $props);
1631 $fieldSpec = $fieldSpec['values'];
1632 $fieldSpecLabel = $fieldSpec['html']['label'] ?? CRM_Utils_Array
::value('title', $fieldSpec);
1633 $label = CRM_Utils_Array
::value('label', $props, $fieldSpecLabel);
1635 $widget = $props['type'] ??
$fieldSpec['html']['type'];
1636 if ($widget == 'TextArea' && $context == 'search') {
1640 $isSelect = (in_array($widget, [
1649 // Fetch options from the api unless passed explicitly.
1650 if (isset($props['options'])) {
1651 $options = $props['options'];
1654 $options = $fieldSpec['options'] ??
NULL;
1656 if ($context == 'search') {
1657 $widget = $widget == 'Select2' ?
$widget : 'Select';
1658 $props['multiple'] = CRM_Utils_Array
::value('multiple', $props, TRUE);
1661 // Add data for popup link.
1662 $canEditOptions = CRM_Core_Permission
::check('administer CiviCRM');
1663 $hasOptionUrl = !empty($props['option_url']);
1664 $optionUrlKeyIsSet = array_key_exists('option_url', $props);
1665 $shouldAdd = $context !== 'search' && $isSelect && $canEditOptions;
1667 // Only add if key is not set, or if non-empty option url is provided
1668 if (($hasOptionUrl ||
!$optionUrlKeyIsSet) && $shouldAdd) {
1669 $optionUrl = $hasOptionUrl ?
$props['option_url'] :
1670 CRM_Core_PseudoConstant
::getOptionEditUrl($fieldSpec);
1671 $props['data-option-edit-path'] = $optionUrl;
1672 $props['data-api-entity'] = $props['entity'];
1673 $props['data-api-field'] = $props['name'];
1676 $props +
= CRM_Utils_Array
::value('html', $fieldSpec, []);
1677 if (in_array($widget, ['Select', 'Select2'])
1678 && !array_key_exists('placeholder', $props)
1679 && $placeholder = self
::selectOrAnyPlaceholder($props, $required, $label)) {
1680 $props['placeholder'] = $placeholder;
1682 CRM_Utils_Array
::remove($props, 'entity', 'name', 'context', 'label', 'action', 'type', 'option_url', 'options');
1684 // TODO: refactor switch statement, to separate methods.
1690 //TODO: Autodetect ranges
1691 $props['size'] = $props['size'] ??
60;
1692 return $this->add(strtolower($widget), $name, $label, $props, $required);
1695 return $this->add('hidden', $name, NULL, $props, $required);
1698 //Set default columns and rows for textarea.
1699 $props['rows'] = $props['rows'] ??
4;
1700 $props['cols'] = $props['cols'] ??
60;
1701 if (empty($props['maxlength']) && isset($fieldSpec['length'])) {
1702 $props['maxlength'] = $fieldSpec['length'];
1704 return $this->add('textarea', $name, $label, $props, $required);
1707 // This is a white list for fields that have been tested with
1708 // date picker. We should be able to remove the other
1710 //TODO: add range support
1711 //TODO: Add date formats
1712 //TODO: Add javascript template for dates.
1713 return $this->addDate($name, $label, $required, $props);
1716 $fieldSpec = CRM_Utils_Date
::addDateMetadataToField($fieldSpec, $fieldSpec);
1717 $attributes = ['format' => $fieldSpec['date_format']];
1718 return $this->add('datepicker', $name, $label, $attributes, $required, $fieldSpec['datepicker']['extra']);
1722 $separator = $props['separator'] ??
NULL;
1723 unset($props['separator']);
1724 if (!isset($props['allowClear'])) {
1725 $props['allowClear'] = !$required;
1727 return $this->addRadio($name, $label, $options, $props, $separator, $required);
1731 'required' => $required,
1733 'multiple' => $context == 'search',
1735 return $this->addChainSelect($name, $props);
1739 $props['class'] = CRM_Utils_Array
::value('class', $props, 'big') . ' crm-select2';
1740 // TODO: Add and/or option for fields that store multiple values
1741 return $this->add(strtolower($widget), $name, $label, $options, $required, $props);
1743 case 'CheckBoxGroup':
1744 return $this->addCheckBox($name, $label, array_flip($options), $required, $props);
1747 return $this->addRadio($name, $label, $options, $props, NULL, $required);
1750 if ($context === 'search') {
1751 $this->addYesNo($name, $label, TRUE, FALSE, $props);
1754 $text = $props['text'] ??
NULL;
1755 unset($props['text']);
1756 return $this->addElement('checkbox', $name, $label, $text, $props);
1758 //add support for 'Advcheckbox' field
1760 $text = $props['text'] ??
NULL;
1761 unset($props['text']);
1762 return $this->addElement('advcheckbox', $name, $label, $text, $props);
1765 // We should not build upload file in search mode.
1766 if ($context == 'search') {
1769 $file = $this->add('file', $name, $label, $props, $required);
1770 $this->addUploadElement($name);
1773 case 'RichTextEditor':
1774 return $this->add('wysiwyg', $name, $label, $props, $required);
1777 return $this->addEntityRef($name, $label, $props, $required);
1780 $props['size'] = $props['size'] ??
60;
1781 return $this->add('password', $name, $label, $props, $required);
1783 // Check datatypes of fields
1787 //case read only fields
1789 throw new Exception("Unsupported html-element " . $widget);
1794 * Add a widget for selecting/editing/creating/copying a profile form
1796 * @param string $name
1797 * HTML form-element name.
1798 * @param string $label
1800 * @param string $allowCoreTypes
1801 * Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'.
1802 * @param string $allowSubTypes
1803 * Only present a UFGroup if its group_type is compatible with $allowSubypes.
1804 * @param array $entities
1805 * @param bool $default
1807 * @param string $usedFor
1809 public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) {
1811 // FIXME: Instead of adhoc serialization, use a single json_encode()
1812 CRM_UF_Page_ProfileEditor
::registerProfileScripts();
1813 CRM_UF_Page_ProfileEditor
::registerSchemas(CRM_Utils_Array
::collect('entity_type', $entities));
1814 $this->add('text', $name, $label, [
1815 'class' => 'crm-profile-selector',
1816 // Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML
1817 'data-group-type' => CRM_Core_BAO_UFGroup
::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'),
1818 'data-entities' => json_encode($entities),
1820 'data-default' => $default,
1821 'data-usedfor' => json_encode($usedFor),
1828 public function getRootTitle() {
1835 public function getCompleteTitle() {
1836 return $this->getRootTitle() . $this->getTitle();
1840 * @return CRM_Core_Smarty
1842 public static function &getTemplate() {
1843 return self
::$_template;
1847 * @param $elementName
1849 public function addUploadElement($elementName) {
1850 $uploadNames = $this->get('uploadNames');
1851 if (!$uploadNames) {
1854 if (is_array($elementName)) {
1855 foreach ($elementName as $name) {
1856 if (!in_array($name, $uploadNames)) {
1857 $uploadNames[] = $name;
1862 if (!in_array($elementName, $uploadNames)) {
1863 $uploadNames[] = $elementName;
1866 $this->set('uploadNames', $uploadNames);
1868 $config = CRM_Core_Config
::singleton();
1869 if (!empty($uploadNames)) {
1870 $this->controller
->addUploadAction($config->customFileUploadDir
, $uploadNames);
1879 public function getVar($name) {
1880 return $this->$name ??
NULL;
1887 public function setVar($name, $value) {
1888 $this->$name = $value;
1895 * Use $this->add('datepicker', ...) instead.
1897 * @param string $name
1898 * Name of the element.
1899 * @param string $label
1900 * Label of the element.
1901 * @param bool $required
1903 * @param array $attributes
1906 public function addDate($name, $label, $required = FALSE, $attributes = NULL) {
1907 if (!empty($attributes['formatType'])) {
1908 // get actual format
1909 $params = ['name' => $attributes['formatType']];
1912 // cache date information
1914 $key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']);
1915 if (empty($dateFormat[$key])) {
1916 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
1917 $dateFormat[$key] = $values;
1920 $values = $dateFormat[$key];
1923 if ($values['date_format']) {
1924 $attributes['format'] = $values['date_format'];
1927 if (!empty($values['time_format'])) {
1928 $attributes['timeFormat'] = $values['time_format'];
1930 $attributes['startOffset'] = $values['start'];
1931 $attributes['endOffset'] = $values['end'];
1934 $config = CRM_Core_Config
::singleton();
1935 if (empty($attributes['format'])) {
1936 $attributes['format'] = $config->dateInputFormat
;
1939 if (!isset($attributes['startOffset'])) {
1940 $attributes['startOffset'] = 10;
1943 if (!isset($attributes['endOffset'])) {
1944 $attributes['endOffset'] = 10;
1947 $this->add('text', $name, $label, $attributes);
1949 if (!empty($attributes['addTime']) ||
!empty($attributes['timeFormat'])) {
1951 if (!isset($attributes['timeFormat'])) {
1952 $timeFormat = $config->timeInputFormat
;
1955 $timeFormat = $attributes['timeFormat'];
1958 // 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively
1960 $show24Hours = TRUE;
1961 if ($timeFormat == 1) {
1962 $show24Hours = FALSE;
1965 //CRM-6664 -we are having time element name
1966 //in either flat string or an array format.
1967 $elementName = $name . '_time';
1968 if (substr($name, -1) == ']') {
1969 $elementName = substr($name, 0, strlen($name) - 1) . '_time]';
1972 $this->add('text', $elementName, ts('Time'), ['timeFormat' => $show24Hours]);
1977 $this->addRule($name, ts('Please select %1', [1 => $label]), 'required');
1978 if (!empty($attributes['addTime']) && !empty($attributes['addTimeRequired'])) {
1979 $this->addRule($elementName, ts('Please enter a time.'), 'required');
1985 * Function that will add date and time.
1988 * Use $this->add('datepicker', ...) instead.
1990 * @param string $name
1991 * @param string $label
1992 * @param bool $required
1993 * @param null $attributes
1995 public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
1996 $addTime = ['addTime' => TRUE];
1997 if (is_array($attributes)) {
1998 $attributes = array_merge($attributes, $addTime);
2001 $attributes = $addTime;
2004 $this->addDate($name, $label, $required, $attributes);
2008 * Add a currency and money element to the form.
2010 * @param string $name
2011 * @param string $label
2012 * @param bool $required
2013 * @param null $attributes
2014 * @param bool $addCurrency
2015 * @param string $currencyName
2016 * @param null $defaultCurrency
2017 * @param bool $freezeCurrency
2019 * @return \HTML_QuickForm_Element
2021 public function addMoney(
2026 $addCurrency = TRUE,
2027 $currencyName = 'currency',
2028 $defaultCurrency = NULL,
2029 $freezeCurrency = FALSE
2031 $element = $this->add('text', $name, $label, $attributes, $required);
2032 $this->addRule($name, ts('Please enter a valid amount.'), 'money');
2035 $ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency);
2042 * Add currency element to the form.
2044 * @param string $name
2045 * @param null $label
2046 * @param bool $required
2047 * @param string $defaultCurrency
2048 * @param bool $freezeCurrency
2049 * @param bool $setDefaultCurrency
2051 public function addCurrency(
2055 $defaultCurrency = NULL,
2056 $freezeCurrency = FALSE,
2057 $setDefaultCurrency = TRUE
2059 $currencies = CRM_Core_OptionGroup
::values('currencies_enabled');
2060 if (!empty($defaultCurrency) && !array_key_exists($defaultCurrency, $currencies)) {
2061 Civi
::log()->warning('addCurrency: Currency ' . $defaultCurrency . ' is disabled but still in use!');
2062 $currencies[$defaultCurrency] = $defaultCurrency;
2064 $options = ['class' => 'crm-select2 eight'];
2066 $currencies = ['' => ''] +
$currencies;
2067 $options['placeholder'] = ts('- none -');
2069 $ele = $this->add('select', $name, $label, $currencies, $required, $options);
2070 if ($freezeCurrency) {
2073 if (!$defaultCurrency) {
2074 $config = CRM_Core_Config
::singleton();
2075 $defaultCurrency = $config->defaultCurrency
;
2077 // In some case, setting currency field by default might override the default value
2078 // as encountered in CRM-20527 for batch data entry
2079 if ($setDefaultCurrency) {
2080 $this->setDefaults([$name => $defaultCurrency]);
2085 * Create a single or multiple entity ref field.
2086 * @param string $name
2087 * @param string $label
2088 * @param array $props
2089 * Mix of html and widget properties, including:.
2090 * - select - params to give to select2 widget
2091 * - entity - defaults to Contact
2092 * - create - can the user create a new entity on-the-fly?
2093 * Set to TRUE if entity is contact and you want the default profiles,
2094 * or pass in your own set of links. @see CRM_Campaign_BAO_Campaign::getEntityRefCreateLinks for format
2095 * note that permissions are checked automatically
2096 * - api - array of settings for the getlist api wrapper
2097 * note that it accepts a 'params' setting which will be passed to the underlying api
2098 * - placeholder - string
2100 * - class, etc. - other html properties
2101 * @param bool $required
2103 * @return HTML_QuickForm_Element
2105 public function addEntityRef($name, $label = '', $props = [], $required = FALSE) {
2106 // Default properties
2107 $props['api'] = CRM_Utils_Array
::value('api', $props, []);
2108 $props['entity'] = CRM_Core_DAO_AllCoreTables
::convertEntityNameToCamel($props['entity'] ??
'Contact');
2109 $props['class'] = ltrim(($props['class'] ??
'') . ' crm-form-entityref');
2111 if (array_key_exists('create', $props) && empty($props['create'])) {
2112 unset($props['create']);
2115 $props['placeholder'] = $props['placeholder'] ?? self
::selectOrAnyPlaceholder($props, $required);
2118 if (!empty($props['multiple'])) {
2119 $defaults['multiple'] = TRUE;
2121 $props['select'] = CRM_Utils_Array
::value('select', $props, []) +
$defaults;
2123 $this->formatReferenceFieldAttributes($props, get_class($this));
2124 return $this->add('text', $name, $label, $props, $required);
2128 * @param array $props
2129 * @param string $formName
2131 private function formatReferenceFieldAttributes(&$props, $formName) {
2132 CRM_Utils_Hook
::alterEntityRefParams($props, $formName);
2133 $props['data-select-params'] = json_encode($props['select']);
2134 $props['data-api-params'] = $props['api'] ?
json_encode($props['api']) : NULL;
2135 $props['data-api-entity'] = $props['entity'];
2136 if (!empty($props['create'])) {
2137 $props['data-create-links'] = json_encode($props['create']);
2139 CRM_Utils_Array
::remove($props, 'multiple', 'select', 'api', 'entity', 'create');
2143 * Convert all date fields within the params to mysql date ready for the
2144 * BAO layer. In this case fields are checked against the $_datefields defined for the form
2145 * and if time is defined it is incorporated
2147 * @param array $params
2148 * Input params from the form.
2150 * @todo it would probably be better to work on $this->_params than a passed array
2151 * @todo standardise the format which dates are passed to the BAO layer in & remove date
2154 public function convertDateFieldsToMySQL(&$params) {
2155 foreach ($this->_dateFields
as $fieldName => $specs) {
2156 if (!empty($params[$fieldName])) {
2157 $params[$fieldName] = CRM_Utils_Date
::isoToMysql(
2158 CRM_Utils_Date
::processDate(
2159 $params[$fieldName],
2160 CRM_Utils_Array
::value("{$fieldName}_time", $params), TRUE)
2164 if (isset($specs['default'])) {
2165 $params[$fieldName] = date('YmdHis', strtotime($specs['default']));
2172 * @param $elementName
2174 public function removeFileRequiredRules($elementName) {
2175 $this->_required
= array_diff($this->_required
, [$elementName]);
2176 if (isset($this->_rules
[$elementName])) {
2177 foreach ($this->_rules
[$elementName] as $index => $ruleInfo) {
2178 if ($ruleInfo['type'] == 'uploadedfile') {
2179 unset($this->_rules
[$elementName][$index]);
2182 if (empty($this->_rules
[$elementName])) {
2183 unset($this->_rules
[$elementName]);
2189 * Function that can be defined in Form to override or.
2190 * perform specific action on cancel action
2192 public function cancelAction() {
2196 * Helper function to verify that required fields have been filled.
2198 * Typically called within the scope of a FormRule function
2200 * @param array $fields
2201 * @param array $values
2202 * @param array $errors
2204 public static function validateMandatoryFields($fields, $values, &$errors) {
2205 foreach ($fields as $name => $fld) {
2206 if (!empty($fld['is_required']) && CRM_Utils_System
::isNull(CRM_Utils_Array
::value($name, $values))) {
2207 $errors[$name] = ts('%1 is a required field.', [1 => $fld['title']]);
2213 * Get contact if for a form object. Prioritise
2214 * - cid in URL if 0 (on behalf on someoneelse)
2215 * (@todo consider setting a variable if onbehalf for clarity of downstream 'if's
2216 * - logged in user id if it matches the one in the cid in the URL
2217 * - contact id validated from a checksum from a checksum
2218 * - cid from the url if the caller has ACL permission to view
2219 * - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
2223 protected function setContactID() {
2224 $tempID = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
2225 if (isset($this->_params
) && !empty($this->_params
['select_contact_id'])) {
2226 $tempID = $this->_params
['select_contact_id'];
2228 if (isset($this->_params
, $this->_params
[0]) && !empty($this->_params
[0]['select_contact_id'])) {
2229 // event form stores as an indexed array, contribution form not so much...
2230 $tempID = $this->_params
[0]['select_contact_id'];
2233 // force to ignore the authenticated user
2234 if ($tempID === '0' ||
$tempID === 0) {
2235 // we set the cid on the form so that this will be retained for the Confirm page
2236 // in the multi-page form & prevent us returning the $userID when this is called
2238 // we don't really need to set it when $tempID is set because the params have that stored
2239 $this->set('cid', 0);
2240 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2241 return (int) $tempID;
2244 $userID = CRM_Core_Session
::getLoggedInContactID();
2246 if (!is_null($tempID) && $tempID === $userID) {
2247 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2248 return (int) $userID;
2251 //check if this is a checksum authentication
2252 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
2253 if ($userChecksum) {
2254 //check for anonymous user.
2255 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($tempID, $userChecksum);
2257 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2258 CRM_Core_Resources
::singleton()->addVars('coreForm', ['checksum' => $userChecksum]);
2262 // check if user has permission, CRM-12062
2263 elseif ($tempID && CRM_Contact_BAO_Contact_Permission
::allow($tempID)) {
2264 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2267 if (is_numeric($userID)) {
2268 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $userID]);
2270 return is_numeric($userID) ?
$userID : NULL;
2274 * Get the contact id that the form is being submitted for.
2278 public function getContactID() {
2279 return $this->setContactID();
2283 * Get the contact id of the logged in user.
2288 public function getLoggedInUserContactID() {
2289 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_Session::getLoggedInContactID()');
2290 // check if the user is logged in and has a contact ID
2291 $session = CRM_Core_Session
::singleton();
2292 return $session->get('userID') ?
(int) $session->get('userID') : FALSE;
2296 * Add autoselector field -if user has permission to view contacts
2297 * If adding this to a form you also need to add to the tpl e.g
2299 * {if !empty($selectable)}
2300 * <div class="crm-summary-row">
2301 * <div class="crm-label">{$form.select_contact.label}</div>
2302 * <div class="crm-content">
2303 * {$form.select_contact.html}
2308 * @param array $profiles
2309 * Ids of profiles that are on the form (to be autofilled).
2310 * @param array $autoCompleteField
2314 * - url (for ajax lookup)
2316 * @throws \CRM_Core_Exception
2317 * @todo add data attributes so we can deal with multiple instances on a form
2319 public function addAutoSelector($profiles = [], $autoCompleteField = []) {
2320 $autoCompleteField = array_merge([
2321 'id_field' => 'select_contact_id',
2322 'placeholder' => ts('Select someone else ...'),
2323 'show_hide' => TRUE,
2324 'api' => ['params' => ['contact_type' => 'Individual']],
2325 ], $autoCompleteField);
2327 if ($this->canUseAjaxContactLookups()) {
2328 $this->assign('selectable', $autoCompleteField['id_field']);
2329 $this->addEntityRef($autoCompleteField['id_field'], NULL, [
2330 'placeholder' => $autoCompleteField['placeholder'],
2331 'api' => $autoCompleteField['api'],
2334 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/AlternateContactSelector.js', 1, 'html-header')
2336 'form' => ['autocompletes' => $autoCompleteField],
2337 'ids' => ['profile' => $profiles],
2344 public function canUseAjaxContactLookups() {
2345 if (0 < (civicrm_api3('contact', 'getcount', ['check_permissions' => 1])) &&
2346 CRM_Core_Permission
::check([['access AJAX API', 'access CiviCRM']])
2353 * Add the options appropriate to cid = zero - ie. autocomplete
2355 * @todo there is considerable code duplication between the contribution forms & event forms. It is apparent
2356 * that small pieces of duplication are not being refactored into separate functions because their only shared parent
2357 * is this form. Inserting a class FrontEndForm.php between the contribution & event & this class would allow functions like this
2358 * and a dozen other small ones to be refactored into a shared parent with the reduction of much code duplication
2360 public function addCIDZeroOptions() {
2361 $this->assign('nocid', TRUE);
2363 if ($this->_values
['custom_pre_id']) {
2364 $profiles[] = $this->_values
['custom_pre_id'];
2366 if ($this->_values
['custom_post_id']) {
2367 $profiles = array_merge($profiles, (array) $this->_values
['custom_post_id']);
2369 $profiles[] = 'billing';
2370 if (!empty($this->_values
)) {
2371 $this->addAutoSelector($profiles);
2376 * Set default values on form for given contact (or no contact defaults)
2378 * @param mixed $profile_id
2379 * (can be id, or profile name).
2380 * @param int $contactID
2384 public function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) {
2386 $defaults = civicrm_api3('profile', 'getsingle', [
2387 'profile_id' => (array) $profile_id,
2388 'contact_id' => $contactID,
2392 catch (Exception
$e) {
2393 // the try catch block gives us silent failure -not 100% sure this is a good idea
2394 // as silent failures are often worse than noisy ones
2400 * Sets form attribute.
2403 public function preventAjaxSubmit() {
2404 $this->setAttribute('data-no-ajax-submit', 'true');
2408 * Sets form attribute.
2411 public function allowAjaxSubmit() {
2412 $this->removeAttribute('data-no-ajax-submit');
2416 * Sets page title based on entity and action.
2417 * @param string $entityLabel
2419 public function setPageTitle($entityLabel) {
2420 switch ($this->_action
) {
2421 case CRM_Core_Action
::ADD
:
2422 $this->setTitle(ts('New %1', [1 => $entityLabel]));
2425 case CRM_Core_Action
::UPDATE
:
2426 $this->setTitle(ts('Edit %1', [1 => $entityLabel]));
2429 case CRM_Core_Action
::VIEW
:
2430 case CRM_Core_Action
::PREVIEW
:
2431 $this->setTitle(ts('View %1', [1 => $entityLabel]));
2434 case CRM_Core_Action
::DELETE
:
2435 $this->setTitle(ts('Delete %1', [1 => $entityLabel]));
2441 * Create a chain-select target field. All settings are optional; the defaults usually work.
2443 * @param string $elementName
2444 * @param array $settings
2446 * @return HTML_QuickForm_Element
2448 public function addChainSelect($elementName, $settings = []) {
2449 $required = $settings['required'] ??
FALSE;
2450 $label = strpos($elementName, 'rovince') ? CRM_Core_DAO_StateProvince
::getEntityTitle() : CRM_Core_DAO_County
::getEntityTitle();
2451 $props = $settings +
= [
2452 'control_field' => str_replace(['state_province', 'StateProvince', 'county', 'County'], [
2458 'data-callback' => strpos($elementName, 'rovince') ?
'civicrm/ajax/jqState' : 'civicrm/ajax/jqCounty',
2460 'data-empty-prompt' => strpos($elementName, 'rovince') ?
ts('Choose country first') : ts('Choose state first'),
2461 'data-none-prompt' => ts('- N/A -'),
2462 'multiple' => FALSE,
2463 'required' => $required,
2464 'placeholder' => ts('- select %1 -', [1 => $label]),
2466 CRM_Utils_Array
::remove($props, 'label', 'required', 'control_field', 'context');
2467 $props['class'] = (empty($props['class']) ?
'' : "{$props['class']} ") . 'crm-select2' . ($required ?
' required crm-field-required' : '');
2468 $props['data-select-prompt'] = $props['placeholder'];
2469 $props['data-name'] = $elementName;
2471 $this->_chainSelectFields
[$settings['control_field']] = $elementName;
2473 // Passing NULL instead of an array of options
2474 // CRM-15225 - normally QF will reject any selected values that are not part of the field's options, but due to a
2475 // quirk in our patched version of HTML_QuickForm_select, this doesn't happen if the options are NULL
2476 // which seems a bit dirty but it allows our dynamically-popuplated select element to function as expected.
2477 return $this->add('select', $elementName, $settings['label'], NULL, $required, $props);
2481 * Add actions menu to results form.
2483 * @param array $tasks
2485 public function addTaskMenu($tasks) {
2486 if (is_array($tasks) && !empty($tasks)) {
2487 // Set constants means this will always load with an empty value, not reloading any submitted value.
2488 // This is appropriate as it is a pseudofield.
2489 $this->setConstants(['task' => '']);
2490 $this->assign('taskMetaData', $tasks);
2491 $select = $this->add('select', 'task', NULL, ['' => ts('Actions')], FALSE, [
2492 'class' => 'crm-select2 crm-action-menu fa-check-circle-o huge crm-search-result-actions',
2495 foreach ($tasks as $key => $task) {
2497 if (isset($task['data'])) {
2498 foreach ($task['data'] as $dataKey => $dataValue) {
2499 $attributes['data-' . $dataKey] = $dataValue;
2502 $select->addOption($task['title'], $key, $attributes);
2504 if (empty($this->_actionButtonName
)) {
2505 $this->_actionButtonName
= $this->getButtonName('next', 'action');
2507 $this->assign('actionButtonName', $this->_actionButtonName
);
2508 $this->add('xbutton', $this->_actionButtonName
, ts('Go'), [
2510 'class' => 'hiddenElement crm-search-go-button',
2513 // Radio to choose "All items" or "Selected items only"
2514 $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', ['checked' => 'checked']);
2515 $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
2516 $this->assign('ts_sel_id', $selectedRowsRadio->_attributes
['id']);
2517 $this->assign('ts_all_id', $allRowsRadio->_attributes
['id']);
2519 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header');
2524 * Set options and attributes for chain select fields based on the controlling field's value
2526 private function preProcessChainSelectFields() {
2527 foreach ($this->_chainSelectFields
as $control => $target) {
2528 // The 'target' might get missing if extensions do removeElement() in a form hook.
2529 if ($this->elementExists($target)) {
2530 $targetField = $this->getElement($target);
2531 $targetType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ?
'county' : 'stateProvince';
2533 // If the control field is on the form, setup chain-select and dynamically populate options
2534 if ($this->elementExists($control)) {
2535 $controlField = $this->getElement($control);
2536 $controlType = $targetType == 'county' ?
'stateProvince' : 'country';
2538 $targetField->setAttribute('class', $targetField->getAttribute('class') . ' crm-chain-select-target');
2540 $css = (string) $controlField->getAttribute('class');
2541 $controlField->updateAttributes([
2542 'class' => ($css ?
"$css " : 'crm-select2 ') . 'crm-chain-select-control',
2543 'data-target' => $target,
2545 $controlValue = $controlField->getValue();
2546 if ($controlValue) {
2547 $options = CRM_Core_BAO_Location
::getChainSelectValues($controlValue, $controlType, TRUE);
2549 $targetField->setAttribute('placeholder', $targetField->getAttribute('data-none-prompt'));
2553 $targetField->setAttribute('placeholder', $targetField->getAttribute('data-empty-prompt'));
2554 $targetField->setAttribute('disabled', 'disabled');
2557 // Control field not present - fall back to loading default options
2559 $options = CRM_Core_PseudoConstant
::$targetType();
2561 if (!$targetField->getAttribute('multiple')) {
2562 $options = ['' => $targetField->getAttribute('placeholder')] +
$options;
2563 $targetField->removeAttribute('placeholder');
2565 $targetField->_options
= [];
2566 $targetField->loadArray($options);
2572 * Validate country / state / county match and suppress unwanted "required" errors
2574 private function validateChainSelectFields() {
2575 foreach ($this->_chainSelectFields
as $control => $target) {
2576 if ($this->elementExists($control) && $this->elementExists($target)) {
2577 $controlValue = (array) $this->getElementValue($control);
2578 $targetField = $this->getElement($target);
2579 $controlType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ?
'stateProvince' : 'country';
2580 $targetValue = array_filter((array) $targetField->getValue());
2581 if ($targetValue ||
$this->getElementError($target)) {
2582 $options = CRM_Core_BAO_Location
::getChainSelectValues($controlValue, $controlType, TRUE);
2584 if (!array_intersect($targetValue, array_keys($options))) {
2585 $this->setElementError($target, $controlType == 'country' ?
ts('State/Province does not match the selected Country') : ts('County does not match the selected State/Province'));
2588 // Suppress "required" error for field if it has no options
2589 elseif (!$options) {
2590 $this->setElementError($target, NULL);
2598 * Assign billing name to the template.
2600 * @param array $params
2601 * Form input params, default to $this->_params.
2605 public function assignBillingName($params = []) {
2607 if (empty($params)) {
2608 $params = $this->_params
;
2610 if (!empty($params['billing_first_name'])) {
2611 $name = $params['billing_first_name'];
2614 if (!empty($params['billing_middle_name'])) {
2615 $name .= " {$params['billing_middle_name']}";
2618 if (!empty($params['billing_last_name'])) {
2619 $name .= " {$params['billing_last_name']}";
2621 $name = trim($name);
2622 $this->assign('billingName', $name);
2627 * Get the currency for the form.
2629 * @todo this should be overriden on the forms rather than having this
2630 * historic, possible handling in here. As we clean that up we should
2631 * add deprecation notices into here.
2633 * @param array $submittedValues
2634 * Array allowed so forms inheriting this class do not break.
2635 * Ideally we would make a clear standard around how submitted values
2636 * are stored (is $this->_values consistently doing that?).
2640 public function getCurrency($submittedValues = []) {
2641 $currency = $this->_values
['currency'] ??
NULL;
2642 // For event forms, currency is in a different spot
2643 if (empty($currency)) {
2644 $currency = CRM_Utils_Array
::value('currency', CRM_Utils_Array
::value('event', $this->_values
));
2646 if (empty($currency)) {
2647 $currency = CRM_Utils_Request
::retrieveValue('currency', 'String');
2649 // @todo If empty there is a problem - we should probably put in a deprecation notice
2650 // to warn if that seems to be happening.
2655 * Is the form in view or edit mode.
2657 * The 'addField' function relies on the form action being one of a set list
2658 * of actions. Checking for these allows for an early return.
2662 protected function isFormInViewOrEditMode() {
2663 return $this->isFormInViewMode() ||
$this->isFormInEditMode();
2667 * Is the form in edit mode.
2669 * Helper function, notably for extensions implementing the buildForm hook,
2670 * so that they can return early.
2674 public function isFormInEditMode() {
2675 return in_array($this->_action
, [
2676 CRM_Core_Action
::UPDATE
,
2677 CRM_Core_Action
::ADD
,
2678 CRM_Core_Action
::BROWSE
,
2679 CRM_Core_Action
::BASIC
,
2680 CRM_Core_Action
::ADVANCED
,
2681 CRM_Core_Action
::PREVIEW
,
2686 * Is the form in view mode.
2688 * Helper function, notably for extensions implementing the buildForm hook,
2689 * so that they can return early.
2693 public function isFormInViewMode() {
2694 return $this->_action
== CRM_Core_Action
::VIEW
;
2698 * Set the active tab
2700 * @param string $default
2702 * @throws \CRM_Core_Exception
2704 public function setSelectedChild($default = NULL) {
2705 $selectedChild = CRM_Utils_Request
::retrieve('selectedChild', 'Alphanumeric', $this, FALSE, $default);
2706 if (!empty($selectedChild)) {
2707 $this->set('selectedChild', $selectedChild);
2708 $this->assign('selectedChild', $selectedChild);
2709 Civi
::resources()->addSetting(['tabSettings' => ['active' => $selectedChild]]);
2714 * Get the contact if from the url, using the checksum or the cid if it is the logged in user.
2716 * This function returns the user being validated. It is not intended to get another user
2717 * they have permission to (setContactID does do that) and can be used to check if the user is
2718 * accessing their own record.
2721 * @throws \CRM_Core_Exception
2723 protected function getContactIDIfAccessingOwnRecord() {
2724 $contactID = (int) CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
2728 if ($contactID === CRM_Core_Session
::getLoggedInContactID()) {
2731 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
2732 return CRM_Contact_BAO_Contact_Utils
::validChecksum($contactID, $userChecksum) ?
$contactID : FALSE;
2736 * Get values submitted by the user.
2738 * These values have been validated against the fields added to the form.
2739 * https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php
2741 * @param string $fieldName
2743 * @return mixed|null
2745 public function getSubmittedValue(string $fieldName) {
2746 if (empty($this->exportedValues
)) {
2747 $this->exportedValues
= $this->controller
->exportValues($this->_name
);
2749 return $this->exportedValues
[$fieldName] ??
NULL;
2753 * Get the active UFGroups (profiles) on this form
2754 * Many forms load one or more UFGroups (profiles).
2755 * This provides a standard function to retrieve the IDs of those profiles from the form
2756 * so that you can implement things such as "is is_captcha field set on any of the active profiles on this form?"
2758 * NOT SUPPORTED FOR USE OUTSIDE CORE EXTENSIONS - Added for reCAPTCHA core extension.
2762 public function getUFGroupIDs() {