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;
184 public function getContext() {
185 return $this->context
;
189 * Set context variable.
191 public function setContext() {
192 $this->context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
196 * @var CRM_Core_Controller
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
207 const ATTR_SPACING
= ' ';
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
217 const CB_PREFIX
= 'mark_x_', CB_PREFIY
= 'mark_y_', CB_PREFIZ
= 'mark_z_', CB_PREFIX_LEN
= 7;
221 * @internal to keep track of chain-select fields
223 private $_chainSelectFields = [];
226 * Extra input types we support via the "add" method
229 public static $html5Types = [
237 * Constructor for the basic form page.
239 * We should not use QuickForm directly. This class provides a lot
240 * of default convenient functions, rules and buttons
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.
250 * @return \CRM_Core_Form
252 public function __construct(
254 $action = CRM_Core_Action
::NONE
,
260 $this->_name
= $name;
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));
267 parent
::__construct($this->_name
, $method);
269 $this->_state
=& $state;
271 $this->_state
->setName($this->_name
);
273 $this->_action
= (int) $action;
275 $this->registerRules();
277 // let the constructor initialize this, should happen only once
278 if (!isset(self
::$_template)) {
279 self
::$_template = CRM_Core_Smarty
::singleton();
281 // Workaround for CRM-15153 - give each form a reasonably unique css class
282 $this->addClass(CRM_Utils_System
::getClassName($this));
284 $this->assign('snippet', CRM_Utils_Array
::value('snippet', $_GET));
285 $this->setTranslatedFields();
289 * Set translated fields.
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.
295 protected function setTranslatedFields() {}
298 * Add one or more css classes to the form.
300 * @param string $className
302 public function addClass($className) {
303 $classes = $this->getAttribute('class');
304 $this->setAttribute('class', ($classes ?
"$classes " : '') . $className);
308 * Register all the standard rules that most forms potentially use.
310 public function registerRules() {
340 foreach ($rules as $rule) {
341 $this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule');
346 * Simple easy to use wrapper around addElement.
348 * Deal with simple validation rules.
350 * @param string $type
351 * @param string $name
352 * @param string $label
353 * @param 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
360 * @return HTML_QuickForm_Element
361 * Could be an error object
363 * @throws \CRM_Core_Exception
365 public function &add(
366 $type, $name, $label = '',
367 $attributes = NULL, $required = FALSE, $extra = NULL
369 if ($type === 'radio') {
370 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Core_Form::addRadio');
373 if ($type !== 'static' && $attributes && !is_array($attributes)) {
374 // The $attributes param used to allow for strings and would default to an
375 // empty string. However, now that the variable is heavily manipulated,
376 // we should expect it to always be an array.
377 Civi
::log()->warning('Attributes passed to CRM_Core_Form::add() are not an array.', ['civi.tag' => 'deprecated']);
379 // Fudge some extra types that quickform doesn't support
381 if ($type == 'wysiwyg' ||
in_array($type, self
::$html5Types)) {
382 $attributes = ($attributes ?
$attributes : []) +
['class' => ''];
383 $attributes['class'] = ltrim($attributes['class'] . " crm-form-$type");
384 if ($type == 'wysiwyg' && isset($attributes['preset'])) {
385 $attributes['data-preset'] = $attributes['preset'];
386 unset($attributes['preset']);
388 $type = $type == 'wysiwyg' ?
'textarea' : 'text';
390 // Like select but accepts rich array data (with nesting, colors, icons, etc) as option list.
391 if ($inputType == 'select2') {
393 $options = $attributes;
394 $attributes = ($extra ?
$extra : []) +
['class' => ''];
395 $attributes['class'] = ltrim($attributes['class'] . " crm-select2 crm-form-select2");
396 $attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]);
397 unset($attributes['multiple']);
401 // @see https://docs.civicrm.org/dev/en/latest/framework/ui/#date-picker
402 if ($type === 'datepicker') {
403 $attributes = $attributes ?
: [];
404 if (!empty($attributes['formatType'])) {
405 $dateAttributes = CRM_Core_SelectValues
::date($attributes['formatType'], NULL, NULL, NULL, 'Input');
406 if (empty($extra['minDate']) && !empty($dateAttributes['minYear'])) {
407 $extra['minDate'] = $dateAttributes['minYear'] . '-01-01';
409 if (empty($extra['maxDate']) && !empty($dateAttributes['minYear'])) {
410 $extra['maxDate'] = $dateAttributes['maxYear'] . '-12-31';
413 // Support minDate/maxDate properties
414 if (isset($extra['minDate'])) {
415 $extra['minDate'] = date('Y-m-d', strtotime($extra['minDate']));
417 if (isset($extra['maxDate'])) {
418 $extra['maxDate'] = date('Y-m-d', strtotime($extra['maxDate']));
421 $attributes['data-crm-datepicker'] = json_encode((array) $extra);
422 if (!empty($attributes['aria-label']) ||
$label) {
423 $attributes['aria-label'] = $attributes['aria-label'] ??
$label;
427 if ($type === 'select' && is_array($extra)) {
428 // Normalize this property
429 if (!empty($extra['multiple'])) {
430 $extra['multiple'] = 'multiple';
433 unset($extra['multiple']);
435 unset($extra['size'], $extra['maxlength']);
436 // Add placeholder option for select
437 if (isset($extra['placeholder'])) {
438 if ($extra['placeholder'] === TRUE) {
439 $extra['placeholder'] = ts('- select %1 -', [1 => $label]);
441 if (($extra['placeholder'] ||
$extra['placeholder'] === '') && empty($extra['multiple']) && is_array($attributes) && !isset($attributes[''])) {
442 $attributes = ['' => $extra['placeholder']] +
$attributes;
446 $optionContext = NULL;
447 if (!empty($extra['option_context'])) {
448 $optionContext = $extra['option_context'];
449 unset($extra['option_context']);
452 $element = $this->addElement($type, $name, CRM_Utils_String
::purifyHTML($label), $attributes, $extra);
453 if (HTML_QuickForm
::isError($element)) {
454 CRM_Core_Error
::statusBounce(HTML_QuickForm
::errorMessage($element));
457 if ($inputType == 'color') {
458 $this->addRule($name, ts('%1 must contain a color value e.g. #ffffff.', [1 => $label]), 'regex', '/#[0-9a-fA-F]{6}/');
462 if ($type == 'file') {
463 $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'uploadedfile');
466 $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'required');
468 if (HTML_QuickForm
::isError($error)) {
469 CRM_Core_Error
::statusBounce(HTML_QuickForm
::errorMessage($element));
473 // Add context for the editing of option groups
474 if ($optionContext) {
475 $element->setAttribute('data-option-edit-context', json_encode($optionContext));
484 * This is called before buildForm. Any pre-processing that
485 * needs to be done for buildForm should be done here.
487 * This is a virtual function and should be redefined if needed.
489 public function preProcess() {
493 * Called after the form is validated.
495 * Any processing of form state etc should be done in this function.
496 * Typically all processing associated with a form should be done
497 * here and relevant state should be stored in the session
499 * This is a virtual function and should be redefined if needed
501 public function postProcess() {
505 * Main process wrapper.
507 * Implemented so that we can call all the hook functions.
509 * @param bool $allowAjax
510 * FIXME: This feels kind of hackish, ideally we would take the json-related code from this function.
511 * and bury it deeper down in the controller
513 public function mainProcess($allowAjax = TRUE) {
514 $this->postProcess();
515 $this->postProcessHook();
517 // Respond with JSON if in AJAX context (also support legacy value '6')
518 if ($allowAjax && !empty($_REQUEST['snippet']) && in_array($_REQUEST['snippet'], [
519 CRM_Core_Smarty
::PRINT_JSON
,
522 $this->ajaxResponse
['buttonName'] = str_replace('_qf_' . $this->getAttribute('id') . '_', '', $this->controller
->getButtonName());
523 $this->ajaxResponse
['action'] = $this->_action
;
524 if (isset($this->_id
) ||
isset($this->id
)) {
525 $this->ajaxResponse
['id'] = $this->id ??
$this->_id
;
527 CRM_Core_Page_AJAX
::returnJsonResponse($this->ajaxResponse
);
532 * The postProcess hook is typically called by the framework.
534 * However in a few cases, the form exits or redirects early in which
535 * case it needs to call this function so other modules can do the needful
536 * Calling this function directly should be avoided if possible. In general a
537 * better way is to do setUserContext so the framework does the redirect
539 public function postProcessHook() {
540 CRM_Utils_Hook
::postProcess(get_class($this), $this);
544 * This virtual function is used to build the form.
546 * It replaces the buildForm associated with QuickForm_Page. This allows us to put
547 * preProcess in front of the actual form building routine
549 public function buildQuickForm() {
553 * This virtual function is used to set the default values of various form elements.
556 * reference to the array of default values
558 public function setDefaultValues() {
563 * This is a virtual function that adds group and global rules to the form.
565 * Keeping it distinct from the form to keep code small
566 * and localized in the form building code
568 public function addRules() {
572 * Performs the server side validation.
575 * true if no error found
576 * @throws HTML_QuickForm_Error
578 public function validate() {
579 $error = parent
::validate();
581 $this->validateChainSelectFields();
585 CRM_Utils_Hook
::validateForm(
587 $this->_submitValues
,
593 if (!empty($hookErrors)) {
594 $this->_errors +
= $hookErrors;
597 return (0 == count($this->_errors
));
601 * Core function that builds the form.
603 * We redefine this function here and expect all CRM forms to build their form in the function
606 public function buildForm() {
607 $this->_formBuilt
= TRUE;
611 CRM_Utils_Hook
::preProcess(get_class($this), $this);
613 $this->assign('translatePermission', CRM_Core_Permission
::check('translate CiviCRM'));
616 $this->controller
->_key
&&
617 $this->controller
->_generateQFKey
619 $this->addElement('hidden', 'qfKey', $this->controller
->_key
);
620 $this->assign('qfKey', $this->controller
->_key
);
624 // _generateQFKey suppresses the qfKey generation on form snippets that
625 // are part of other forms, hence we use that to avoid adding entryURL
626 if ($this->controller
->_generateQFKey
&& $this->controller
->_entryURL
) {
627 $this->addElement('hidden', 'entryURL', $this->controller
->_entryURL
);
630 $this->buildQuickForm();
632 $defaults = $this->setDefaultValues();
633 unset($defaults['qfKey']);
635 if (!empty($defaults)) {
636 $this->setDefaults($defaults);
639 // call the form hook
640 // also call the hook function so any modules can set their own custom defaults
641 // the user can do both the form and set default values with this hook
642 CRM_Utils_Hook
::buildForm(get_class($this), $this);
646 //Set html data-attribute to enable warning user of unsaved changes
647 if ($this->unsavedChangesWarn
=== TRUE
648 ||
(!isset($this->unsavedChangesWarn
)
649 && ($this->_action
& CRM_Core_Action
::ADD ||
$this->_action
& CRM_Core_Action
::UPDATE
)
652 $this->setAttribute('data-warn-changes', 'true');
655 if ($this->submitOnce
) {
656 $this->setAttribute('data-submit-once', 'true');
661 * Add default Next / Back buttons.
663 * @param array $params
664 * Array of associative arrays in the order in which the buttons should be
665 * displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault'
666 * The base form class will define a bunch of static arrays for commonly used
669 public function addButtons($params) {
670 $prevnext = $spacing = [];
671 foreach ($params as $button) {
672 if (!empty($button['submitOnce'])) {
673 $this->submitOnce
= TRUE;
676 $attrs = ['class' => 'crm-form-submit'] +
(array) CRM_Utils_Array
::value('js', $button);
678 // A lot of forms use the hacky method of looking at
679 // `$params['button name']` (dating back to them being inputs with a
680 // "value" of the button label) rather than looking at
681 // `$this->controller->getButtonName()`. It makes sense to give buttons a
682 // value by default as a precaution.
685 if (!empty($button['class'])) {
686 $attrs['class'] .= ' ' . $button['class'];
689 if (!empty($button['isDefault'])) {
690 $attrs['class'] .= ' default';
693 if (in_array($button['type'], ['upload', 'next', 'submit', 'done', 'process', 'refresh'])) {
694 $attrs['class'] .= ' validate';
695 $defaultIcon = 'fa-check';
698 $attrs['class'] .= ' cancel';
699 $defaultIcon = $button['type'] == 'back' ?
'fa-chevron-left' : 'fa-times';
702 if ($button['type'] === 'reset') {
703 $attrs['type'] = 'reset';
704 $prevnext[] = $this->createElement('xbutton', 'reset', $button['name'], $attrs);
707 if (!empty($button['subName'])) {
708 if ($button['subName'] == 'new') {
709 $defaultIcon = 'fa-plus-circle';
711 if ($button['subName'] == 'done') {
712 $defaultIcon = 'fa-check-circle';
714 if ($button['subName'] == 'next') {
715 $defaultIcon = 'fa-chevron-right';
719 if (in_array($button['type'], ['next', 'upload', 'done']) && $button['name'] === ts('Save')) {
720 $attrs['accesskey'] = 'S';
722 $buttonContents = CRM_Core_Page
::crmIcon($button['icon'] ??
$defaultIcon) . ' ' . $button['name'];
723 $buttonName = $this->getButtonName($button['type'], CRM_Utils_Array
::value('subName', $button));
724 $attrs['class'] .= " crm-button crm-button-type-{$button['type']} crm-button{$buttonName}";
725 $attrs['type'] = 'submit';
726 $prevnext[] = $this->createElement('xbutton', $buttonName, $buttonContents, $attrs);
728 if (!empty($button['isDefault'])) {
729 $this->setDefaultAction($button['type']);
732 // if button type is upload, set the enctype
733 if ($button['type'] == 'upload') {
734 $this->updateAttributes(['enctype' => 'multipart/form-data']);
735 $this->setMaxFileSize();
738 // hack - addGroup uses an array to express variable spacing, read from the last element
739 $spacing[] = CRM_Utils_Array
::value('spacing', $button, self
::ATTR_SPACING
);
741 $this->addGroup($prevnext, 'buttons', '', $spacing, FALSE);
745 * Getter function for Name.
749 public function getName() {
754 * Getter function for State.
758 public function &getState() {
759 return $this->_state
;
763 * Getter function for StateType.
767 public function getStateType() {
768 return $this->_state
->getType();
772 * Getter function for title.
774 * Should be over-ridden by derived class.
778 public function getTitle() {
779 return $this->_title ?
$this->_title
: ts('ERROR: Title is not Set');
783 * Setter function for title.
785 * @param string $title
786 * The title of the form.
788 public function setTitle($title) {
789 $this->_title
= $title;
790 CRM_Utils_System
::setTitle($title);
794 * Assign billing type id to bltID.
796 * @throws CRM_Core_Exception
798 public function assignBillingType() {
799 $this->_bltID
= CRM_Core_BAO_LocationType
::getBilling();
800 $this->set('bltID', $this->_bltID
);
801 $this->assign('bltID', $this->_bltID
);
807 public function getPaymentProcessorID() {
808 return $this->_paymentProcessorID
;
812 * This if a front end form function for setting the payment processor.
814 * It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.
816 * @param bool $isPayLaterEnabled
818 * @throws \CRM_Core_Exception
820 protected function assignPaymentProcessor($isPayLaterEnabled) {
821 $this->_paymentProcessors
= CRM_Financial_BAO_PaymentProcessor
::getPaymentProcessors([ucfirst($this->_mode
) . 'Mode'], $this->_paymentProcessorIDs
);
822 if ($isPayLaterEnabled) {
823 $this->_paymentProcessors
[0] = CRM_Financial_BAO_PaymentProcessor
::getPayment(0);
826 if (!empty($this->_paymentProcessors
)) {
827 foreach ($this->_paymentProcessors
as $paymentProcessorID => $paymentProcessorDetail) {
828 if (empty($this->_paymentProcessor
) && $paymentProcessorDetail['is_default'] == 1 ||
(count($this->_paymentProcessors
) == 1)
830 $this->_paymentProcessor
= $paymentProcessorDetail;
831 $this->assign('paymentProcessor', $this->_paymentProcessor
);
832 // Setting this is a bit of a legacy overhang.
833 $this->_paymentObject
= $paymentProcessorDetail['object'];
836 // It's not clear why we set this on the form.
837 $this->set('paymentProcessors', $this->_paymentProcessors
);
840 throw new CRM_Core_Exception(ts('A payment processor configured for this page might be disabled (contact the site administrator for assistance).'));
845 * Assign an array of variables to the form/tpl
847 * @param array $values Array of [key => value] to assign to the form
848 * @param array $keys Array of keys to assign from the values array
850 public function assignVariables($values, $keys) {
851 foreach ($keys as $key) {
852 $this->assign($key, $values[$key] ??
NULL);
857 * Format the fields in $this->_params for the payment processor.
859 * In order to pass fields to the payment processor in a consistent way we add some renamed
862 * @param array $fields
866 protected function formatParamsForPaymentProcessor($fields) {
867 $this->_params
= $this->prepareParamsForPaymentProcessor($this->_params
);
868 $fields = array_merge($fields, ['first_name' => 1, 'middle_name' => 1, 'last_name' => 1]);
873 * Format the fields in $params for the payment processor.
875 * In order to pass fields to the payment processor in a consistent way we add some renamed
878 * @param array $params Payment processor params
880 * @return array $params
882 protected function prepareParamsForPaymentProcessor($params) {
883 // also add location name to the array
884 $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);
885 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
886 // Add additional parameters that the payment processors are used to receiving.
887 if (!empty($params["billing_state_province_id-{$this->_bltID}"])) {
888 $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}"]);
890 if (!empty($params["billing_country_id-{$this->_bltID}"])) {
891 $params['country'] = $params["country-{$this->_bltID}"] = $params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($params["billing_country_id-{$this->_bltID}"]);
894 list($hasAddressField, $addressParams) = CRM_Contribute_BAO_Contribution
::getPaymentProcessorReadyAddressParams($params, $this->_bltID
);
895 if ($hasAddressField) {
896 $params = array_merge($params, $addressParams);
899 // How does this relate to similar code in CRM_Contact_BAO_Contact::addBillingNameFieldsIfOtherwiseNotSet()?
900 $nameFields = ['first_name', 'middle_name', 'last_name'];
901 foreach ($nameFields as $name) {
902 if (array_key_exists("billing_$name", $params)) {
903 $params[$name] = $params["billing_{$name}"];
904 $params['preserveDBName'] = TRUE;
908 // For legacy reasons we set these creditcard expiry fields if present
909 CRM_Contribute_Form_AbstractEditPayment
::formatCreditCardDetails($params);
911 // Assign IP address parameter
912 $params['ip_address'] = CRM_Utils_System
::ipAddress();
918 * Handle Payment Processor switching for contribution and event registration forms.
920 * This function is shared between contribution & event forms & this is their common class.
922 * However, this should be seen as an in-progress refactor, the end goal being to also align the
923 * backoffice forms that action payments.
925 * This function overlaps assignPaymentProcessor, in a bad way.
927 protected function preProcessPaymentOptions() {
928 $this->_paymentProcessorID
= NULL;
929 if ($this->_paymentProcessors
) {
930 if (!empty($this->_submitValues
)) {
931 $this->_paymentProcessorID
= $this->_submitValues
['payment_processor_id'] ??
NULL;
932 $this->_paymentProcessor
= $this->_paymentProcessors
[$this->_paymentProcessorID
] ??
NULL;
933 $this->set('type', $this->_paymentProcessorID
);
934 $this->set('mode', $this->_mode
);
935 $this->set('paymentProcessor', $this->_paymentProcessor
);
937 // Set default payment processor
939 foreach ($this->_paymentProcessors
as $values) {
940 if (!empty($values['is_default']) ||
count($this->_paymentProcessors
) == 1) {
941 $this->_paymentProcessorID
= $values['id'];
946 if ($this->_paymentProcessorID
947 ||
(isset($this->_submitValues
['payment_processor_id']) && $this->_submitValues
['payment_processor_id'] == 0)
949 CRM_Core_Payment_ProcessorForm
::preProcess($this);
952 $this->_paymentProcessor
= [];
956 // We save the fact that the profile 'billing' is required on the payment form.
957 // Currently pay-later is the only 'processor' that takes notice of this - but ideally
958 // 1) it would be possible to select the minimum_billing_profile_id for the contribution form
959 // 2) that profile_id would be set on the payment processor
960 // 3) the payment processor would return a billing form that combines these user-configured
961 // minimums with the payment processor minimums. This would lead to fields like 'postal_code'
962 // only being on the form if either the admin has configured it as wanted or the processor
964 $this->assign('billing_profile_id', (!empty($this->_values
['is_billing_required']) ?
'billing' : ''));
968 * Handle pre approval for processors.
970 * This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.
972 * This function is shared between contribution & event forms & this is their common class.
974 * However, this should be seen as an in-progress refactor, the end goal being to also align the
975 * backoffice forms that action payments.
977 * @param array $params
979 protected function handlePreApproval(&$params) {
981 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
982 $params['component'] = $params['component'] ??
'contribute';
983 $result = $payment->doPreApproval($params);
984 if (empty($result)) {
985 // This could happen, for example, when paypal looks at the button value & decides it is not paypal express.
989 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
990 CRM_Core_Error
::statusBounce(ts('Payment approval failed with message :') . $e->getMessage(), $payment->getCancelUrl($params['qfKey'], CRM_Utils_Array
::value('participant_id', $params)));
993 $this->set('pre_approval_parameters', $result['pre_approval_parameters']);
994 if (!empty($result['redirect_url'])) {
995 CRM_Utils_System
::redirect($result['redirect_url']);
1000 * Setter function for options.
1002 * @param mixed $options
1004 public function setOptions($options) {
1005 $this->_options
= $options;
1009 * Render form and return contents.
1013 public function toSmarty() {
1014 $this->preProcessChainSelectFields();
1015 $renderer = $this->getRenderer();
1016 $this->accept($renderer);
1017 $content = $renderer->toArray();
1018 $content['formName'] = $this->getName();
1020 $content['formClass'] = CRM_Utils_System
::getClassName($this);
1025 * Getter function for renderer.
1027 * If renderer is not set create one and initialize it.
1031 public function &getRenderer() {
1032 if (!isset($this->_renderer
)) {
1033 $this->_renderer
= CRM_Core_Form_Renderer
::singleton();
1035 return $this->_renderer
;
1039 * Use the form name to create the tpl file name.
1043 public function getTemplateFileName() {
1044 $ext = CRM_Extension_System
::singleton()->getMapper();
1045 if ($ext->isExtensionClass(CRM_Utils_System
::getClassName($this))) {
1046 $filename = $ext->getTemplateName(CRM_Utils_System
::getClassName($this));
1047 $tplname = $ext->getTemplatePath(CRM_Utils_System
::getClassName($this)) . DIRECTORY_SEPARATOR
. $filename;
1051 CRM_Utils_System
::getClassName($this),
1053 '_' => DIRECTORY_SEPARATOR
,
1054 '\\' => DIRECTORY_SEPARATOR
,
1062 * A wrapper for getTemplateFileName.
1064 * This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
1066 public function getHookedTemplateFileName() {
1067 $pageTemplateFile = $this->getTemplateFileName();
1068 CRM_Utils_Hook
::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
1069 return $pageTemplateFile;
1073 * Default extra tpl file basically just replaces .tpl with .extra.tpl.
1075 * i.e. we do not override.
1079 public function overrideExtraTemplateFileName() {
1084 * Error reporting mechanism.
1086 * @param string $message
1090 * @param CRM_Core_DAO $dao
1091 * A data access object on which we perform a rollback if non - empty.
1093 public function error($message, $code = NULL, $dao = NULL) {
1095 $dao->query('ROLLBACK');
1098 $error = CRM_Core_Error
::singleton();
1100 $error->push($code, $message);
1104 * Store the variable with the value in the form scope.
1106 * @param string $name
1107 * Name of the variable.
1108 * @param mixed $value
1109 * Value of the variable.
1111 public function set($name, $value) {
1112 $this->controller
->set($name, $value);
1116 * Get the variable from the form scope.
1118 * @param string $name
1119 * Name of the variable
1123 public function get($name) {
1124 return $this->controller
->get($name);
1128 * Getter for action.
1132 public function getAction() {
1133 return $this->_action
;
1137 * Setter for action.
1139 * @param int $action
1140 * The mode we want to set the form.
1142 public function setAction($action) {
1143 $this->_action
= $action;
1147 * Assign value to name in template.
1149 * @param string $var
1151 * @param mixed $value
1152 * Value of variable.
1154 public function assign($var, $value = NULL) {
1155 self
::$_template->assign($var, $value);
1159 * Assign value to name in template by reference.
1161 * @param string $var
1163 * @param mixed $value
1164 * Value of variable.
1166 public function assign_by_ref($var, &$value) {
1167 self
::$_template->assign_by_ref($var, $value);
1171 * Appends values to template variables.
1173 * @param array|string $tpl_var the template variable name(s)
1174 * @param mixed $value
1175 * The value to append.
1176 * @param bool $merge
1178 public function append($tpl_var, $value = NULL, $merge = FALSE) {
1179 self
::$_template->append($tpl_var, $value, $merge);
1183 * Returns an array containing template variables.
1185 * @param string $name
1189 public function get_template_vars($name = NULL) {
1190 return self
::$_template->get_template_vars($name);
1194 * @param string $name
1197 * @param array $attributes
1198 * @param null $separator
1199 * @param bool $required
1200 * @param array $optionAttributes - Option specific attributes
1202 * @return HTML_QuickForm_group
1204 public function &addRadio($name, $title, $values, $attributes = [], $separator = NULL, $required = FALSE, $optionAttributes = []) {
1206 $attributes = $attributes ?
$attributes : [];
1207 $allowClear = !empty($attributes['allowClear']);
1208 unset($attributes['allowClear']);
1209 $attributes['id_suffix'] = $name;
1210 foreach ($values as $key => $var) {
1211 $optAttributes = $attributes;
1212 if (!empty($optionAttributes[$key])) {
1213 foreach ($optionAttributes[$key] as $optAttr => $optVal) {
1214 $optAttributes[$optAttr] = ltrim(($optAttributes[$optAttr] ??
'') . ' ' . $optVal);
1217 // We use a class here to avoid html5 issues with collapsed cutsomfield sets.
1218 $optAttributes['class'] = $optAttributes['class'] ??
'';
1220 $optAttributes['class'] .= ' required';
1222 $element = $this->createElement('radio', NULL, NULL, $var, $key, $optAttributes);
1223 $options[] = $element;
1225 $group = $this->addGroup($options, $name, $title, $separator);
1227 $optionEditKey = 'data-option-edit-path';
1228 if (!empty($attributes[$optionEditKey])) {
1229 $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1233 $this->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required');
1236 $group->setAttribute('allowClear', TRUE);
1244 * @param bool $allowClear
1245 * @param null $required
1246 * @param array $attributes
1248 public function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = []) {
1249 $attributes +
= ['id_suffix' => $id];
1251 $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes);
1252 $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes);
1254 $group = $this->addGroup($choice, $id, $title);
1256 $group->setAttribute('allowClear', TRUE);
1259 $this->addRule($id, ts('%1 is a required field.', [1 => $title]), 'required');
1267 * @param null $other
1268 * @param null $attributes
1269 * @param null $required
1270 * @param null $javascriptMethod
1271 * @param string $separator
1272 * @param bool $flipValues
1274 public function addCheckBox(
1275 $id, $title, $values, $other = NULL,
1276 $attributes = NULL, $required = NULL,
1277 $javascriptMethod = NULL,
1278 $separator = '<br />', $flipValues = FALSE
1282 if ($javascriptMethod) {
1283 foreach ($values as $key => $var) {
1285 $options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod, $attributes);
1288 $options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod, $attributes);
1293 foreach ($values as $key => $var) {
1295 $options[] = $this->createElement('checkbox', $var, NULL, $key, $attributes);
1298 $options[] = $this->createElement('checkbox', $key, NULL, $var, $attributes);
1303 $group = $this->addGroup($options, $id, $title, $separator);
1304 $optionEditKey = 'data-option-edit-path';
1305 if (!empty($attributes[$optionEditKey])) {
1306 $group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
1310 $this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']);
1315 ts('%1 is a required field.', [1 => $title]),
1321 public function resetValues() {
1322 $data = $this->controller
->container();
1323 $data['values'][$this->_name
] = [];
1327 * Simple shell that derived classes can call to add buttons to
1328 * the form with a customized title for the main Submit
1330 * @param string $title
1331 * Title of the main button.
1332 * @param string $nextType
1333 * Button type for the form after processing.
1334 * @param string $backType
1335 * @param bool|string $submitOnce
1337 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
1339 if ($backType != NULL) {
1341 'type' => $backType,
1342 'name' => ts('Previous'),
1345 if ($nextType != NULL) {
1347 'type' => $nextType,
1349 'isDefault' => TRUE,
1352 $this->submitOnce
= TRUE;
1354 $buttons[] = $nextButton;
1356 $this->addButtons($buttons);
1360 * @param string $name
1361 * @param string $from
1363 * @param string $label
1364 * @param string $dateFormat
1365 * @param bool $required
1366 * @param bool $displayTime
1368 public function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
1369 CRM_Core_Error
::deprecatedFunctionWarning('Use CRM_Core_Form::addDatePickerRange insted');
1371 $this->addDateTime($name . $from, $label, $required, ['formatType' => $dateFormat]);
1372 $this->addDateTime($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1375 $this->addDate($name . $from, $label, $required, ['formatType' => $dateFormat]);
1376 $this->addDate($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
1381 * Add a search for a range using date picker fields.
1383 * @param string $fieldName
1384 * @param string $label
1385 * @param bool $isDateTime
1386 * Is this a date-time field (not just date).
1387 * @param bool $required
1388 * @param string $fromLabel
1389 * @param string $toLabel
1390 * @param array $additionalOptions
1391 * @param string $to string to append to the to field.
1392 * @param string $from string to append to the from field.
1394 public function addDatePickerRange($fieldName, $label, $isDateTime = FALSE, $required = FALSE, $fromLabel = 'From', $toLabel = 'To', $additionalOptions = [],
1395 $to = '_high', $from = '_low') {
1398 '' => ts('- any -'),
1399 0 => ts('Choose Date Range'),
1400 ] + CRM_Core_OptionGroup
::values('relative_date_filters');
1402 if ($additionalOptions) {
1403 foreach ($additionalOptions as $key => $optionLabel) {
1404 $options[$key] = $optionLabel;
1408 $this->add('select',
1409 "{$fieldName}_relative",
1413 ['class' => 'crm-select2']
1415 $attributes = ['formatType' => 'searchDate'];
1416 $extra = ['time' => $isDateTime];
1417 $this->add('datepicker', $fieldName . $from, ts($fromLabel), $attributes, $required, $extra);
1418 $this->add('datepicker', $fieldName . $to, ts($toLabel), $attributes, $required, $extra);
1422 * Based on form action, return a string representing the api action.
1423 * Used by addField method.
1427 protected function getApiAction() {
1428 $action = $this->getAction();
1429 if ($action & (CRM_Core_Action
::UPDATE + CRM_Core_Action
::ADD
)) {
1432 if ($action & (CRM_Core_Action
::VIEW + CRM_Core_Action
::BROWSE + CRM_Core_Action
::BASIC + CRM_Core_Action
::ADVANCED + CRM_Core_Action
::PREVIEW
)) {
1435 if ($action & (CRM_Core_Action
::DELETE
)) {
1438 // If you get this exception try adding more cases above.
1439 throw new Exception("Cannot determine api action for " . get_class($this) . '.' . 'CRM_Core_Action "' . CRM_Core_Action
::description($action) . '" not recognized.');
1443 * Classes extending CRM_Core_Form should implement this method.
1446 public function getDefaultEntity() {
1447 throw new Exception("Cannot determine default entity. " . get_class($this) . " should implement getDefaultEntity().");
1451 * Classes extending CRM_Core_Form should implement this method.
1453 * TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
1456 public function getDefaultContext() {
1457 throw new Exception("Cannot determine default context. " . get_class($this) . " should implement getDefaultContext().");
1461 * Adds a select based on field metadata.
1462 * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata
1463 * Perhaps a method like $form->bind($name) which would look up all metadata for named field
1465 * Field name to go on the form.
1466 * @param array $props
1467 * Mix of html attributes and special properties, namely.
1468 * - entity (api entity name, can usually be inferred automatically from the form class)
1469 * - field (field name - only needed if different from name used on the form)
1470 * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1471 * - placeholder - set to NULL to disable
1473 * - context - @see CRM_Core_DAO::buildOptionsContext
1474 * @param bool $required
1475 * @throws CRM_Core_Exception
1476 * @return HTML_QuickForm_Element
1478 public function addSelect($name, $props = [], $required = FALSE) {
1479 if (!isset($props['entity'])) {
1480 $props['entity'] = $this->getDefaultEntity();
1482 if (!isset($props['field'])) {
1483 $props['field'] = strrpos($name, '[') ?
rtrim(substr($name, 1 +
strrpos($name, '[')), ']') : $name;
1485 if (!isset($props['context'])) {
1487 $props['context'] = $this->getDefaultContext();
1489 // This is not a required param, so we'll ignore if this doesn't exist.
1490 catch (Exception
$e) {
1493 // Fetch options from the api unless passed explicitly
1494 if (isset($props['options'])) {
1495 $options = $props['options'];
1498 $info = civicrm_api3($props['entity'], 'getoptions', $props);
1499 $options = $info['values'];
1501 if (!array_key_exists('placeholder', $props) && $placeholder = self
::selectOrAnyPlaceholder($props, $required)) {
1502 $props['placeholder'] = $placeholder;
1504 // Handle custom field
1505 if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1506 list(, $id) = explode('_', $name);
1507 $label = $props['label'] ?? CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id);
1508 $gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id);
1509 if (CRM_Utils_Array
::value('context', $props) != 'search') {
1510 $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);
1515 $info = civicrm_api3($props['entity'], 'getfields');
1516 foreach ($info['values'] as $uniqueName => $fieldSpec) {
1518 $uniqueName === $props['field'] ||
1519 CRM_Utils_Array
::value('name', $fieldSpec) === $props['field'] ||
1520 in_array($props['field'], CRM_Utils_Array
::value('api.aliases', $fieldSpec, []))
1525 $label = $props['label'] ??
$fieldSpec['title'];
1526 if (CRM_Utils_Array
::value('context', $props) != 'search') {
1527 $props['data-option-edit-path'] = array_key_exists('option_url', $props) ?
$props['option_url'] : CRM_Core_PseudoConstant
::getOptionEditUrl($fieldSpec);
1530 $props['class'] = (isset($props['class']) ?
$props['class'] . ' ' : '') . "crm-select2";
1531 $props['data-api-entity'] = $props['entity'];
1532 $props['data-api-field'] = $props['field'];
1533 CRM_Utils_Array
::remove($props, 'label', 'entity', 'field', 'option_url', 'options', 'context');
1534 return $this->add('select', $name, $label, $options, $required, $props);
1538 * Handles a repeated bit supplying a placeholder for entity selection
1540 * @param string $props
1541 * The field properties, including the entity and context.
1542 * @param bool $required
1543 * If the field is required.
1544 * @param string $title
1545 * A field title, if applicable.
1547 * The placeholder text.
1549 private static function selectOrAnyPlaceholder($props, $required, $title = NULL) {
1550 if (empty($props['entity'])) {
1554 $daoToClass = CRM_Core_DAO_AllCoreTables
::daoToClass();
1555 if (array_key_exists($props['entity'], $daoToClass)) {
1556 $daoClass = $daoToClass[$props['entity']];
1557 $title = $daoClass::getEntityTitle();
1560 $title = ts('option');
1563 if (($props['context'] ??
'') == 'search' && !$required) {
1564 return ts('- any %1 -', [1 => $title]);
1566 return ts('- select %1 -', [1 => $title]);
1570 * Adds a field based on metadata.
1573 * Field name to go on the form.
1574 * @param array $props
1575 * Mix of html attributes and special properties, namely.
1576 * - entity (api entity name, can usually be inferred automatically from the form class)
1577 * - name (field name - only needed if different from name used on the form)
1578 * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
1579 * - placeholder - set to NULL to disable
1581 * - context - @see CRM_Core_DAO::buildOptionsContext
1582 * @param bool $required
1583 * @param bool $legacyDate
1584 * Temporary param to facilitate the conversion of fields to use the datepicker in
1585 * a controlled way. To convert the field the jcalendar code needs to be removed from the
1586 * tpl as well. That file is intended to be EOL.
1588 * @throws \CiviCRM_API3_Exception
1589 * @throws \Exception
1591 * HTML_QuickForm_Element
1594 public function addField($name, $props = [], $required = FALSE, $legacyDate = TRUE) {
1596 if (empty($props['context'])) {
1597 $props['context'] = $this->getDefaultContext();
1599 $context = $props['context'];
1601 if (empty($props['entity'])) {
1602 $props['entity'] = $this->getDefaultEntity();
1605 if (empty($props['name'])) {
1606 $props['name'] = strrpos($name, '[') ?
rtrim(substr($name, 1 +
strrpos($name, '[')), ']') : $name;
1609 if (empty($props['action'])) {
1610 $props['action'] = $this->getApiAction();
1613 // Handle custom fields
1614 if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
1615 $fieldId = (int) substr($name, 7);
1616 return CRM_Core_BAO_CustomField
::addQuickFormElement($this, $name, $fieldId, $required, $context == 'search', CRM_Utils_Array
::value('label', $props));
1619 // Core field - get metadata.
1620 $fieldSpec = civicrm_api3($props['entity'], 'getfield', $props);
1621 $fieldSpec = $fieldSpec['values'];
1622 $fieldSpecLabel = $fieldSpec['html']['label'] ?? CRM_Utils_Array
::value('title', $fieldSpec);
1623 $label = CRM_Utils_Array
::value('label', $props, $fieldSpecLabel);
1625 $widget = $props['type'] ??
$fieldSpec['html']['type'];
1626 if ($widget == 'TextArea' && $context == 'search') {
1630 $isSelect = (in_array($widget, [
1639 // Fetch options from the api unless passed explicitly.
1640 if (isset($props['options'])) {
1641 $options = $props['options'];
1644 $options = $fieldSpec['options'] ??
NULL;
1646 if ($context == 'search') {
1647 $widget = $widget == 'Select2' ?
$widget : 'Select';
1648 $props['multiple'] = CRM_Utils_Array
::value('multiple', $props, TRUE);
1651 // Add data for popup link.
1652 $canEditOptions = CRM_Core_Permission
::check('administer CiviCRM');
1653 $hasOptionUrl = !empty($props['option_url']);
1654 $optionUrlKeyIsSet = array_key_exists('option_url', $props);
1655 $shouldAdd = $context !== 'search' && $isSelect && $canEditOptions;
1657 // Only add if key is not set, or if non-empty option url is provided
1658 if (($hasOptionUrl ||
!$optionUrlKeyIsSet) && $shouldAdd) {
1659 $optionUrl = $hasOptionUrl ?
$props['option_url'] :
1660 CRM_Core_PseudoConstant
::getOptionEditUrl($fieldSpec);
1661 $props['data-option-edit-path'] = $optionUrl;
1662 $props['data-api-entity'] = $props['entity'];
1663 $props['data-api-field'] = $props['name'];
1666 $props +
= CRM_Utils_Array
::value('html', $fieldSpec, []);
1667 if (in_array($widget, ['Select', 'Select2'])
1668 && !array_key_exists('placeholder', $props)
1669 && $placeholder = self
::selectOrAnyPlaceholder($props, $required, $label)) {
1670 $props['placeholder'] = $placeholder;
1672 CRM_Utils_Array
::remove($props, 'entity', 'name', 'context', 'label', 'action', 'type', 'option_url', 'options');
1674 // TODO: refactor switch statement, to separate methods.
1680 //TODO: Autodetect ranges
1681 $props['size'] = $props['size'] ??
60;
1682 return $this->add(strtolower($widget), $name, $label, $props, $required);
1685 return $this->add('hidden', $name, NULL, $props, $required);
1688 //Set default columns and rows for textarea.
1689 $props['rows'] = $props['rows'] ??
4;
1690 $props['cols'] = $props['cols'] ??
60;
1691 if (empty($props['maxlength']) && isset($fieldSpec['length'])) {
1692 $props['maxlength'] = $fieldSpec['length'];
1694 return $this->add('textarea', $name, $label, $props, $required);
1697 // This is a white list for fields that have been tested with
1698 // date picker. We should be able to remove the other
1700 //TODO: add range support
1701 //TODO: Add date formats
1702 //TODO: Add javascript template for dates.
1703 return $this->addDate($name, $label, $required, $props);
1706 $fieldSpec = CRM_Utils_Date
::addDateMetadataToField($fieldSpec, $fieldSpec);
1707 $attributes = ['format' => $fieldSpec['date_format']];
1708 return $this->add('datepicker', $name, $label, $attributes, $required, $fieldSpec['datepicker']['extra']);
1712 $separator = $props['separator'] ??
NULL;
1713 unset($props['separator']);
1714 if (!isset($props['allowClear'])) {
1715 $props['allowClear'] = !$required;
1717 return $this->addRadio($name, $label, $options, $props, $separator, $required);
1721 'required' => $required,
1723 'multiple' => $context == 'search',
1725 return $this->addChainSelect($name, $props);
1729 $props['class'] = CRM_Utils_Array
::value('class', $props, 'big') . ' crm-select2';
1730 // TODO: Add and/or option for fields that store multiple values
1731 return $this->add(strtolower($widget), $name, $label, $options, $required, $props);
1733 case 'CheckBoxGroup':
1734 return $this->addCheckBox($name, $label, array_flip($options), $required, $props);
1737 return $this->addRadio($name, $label, $options, $props, NULL, $required);
1740 if ($context === 'search') {
1741 $this->addYesNo($name, $label, TRUE, FALSE, $props);
1744 $text = $props['text'] ??
NULL;
1745 unset($props['text']);
1746 return $this->addElement('checkbox', $name, $label, $text, $props);
1748 //add support for 'Advcheckbox' field
1750 $text = $props['text'] ??
NULL;
1751 unset($props['text']);
1752 return $this->addElement('advcheckbox', $name, $label, $text, $props);
1755 // We should not build upload file in search mode.
1756 if ($context == 'search') {
1759 $file = $this->add('file', $name, $label, $props, $required);
1760 $this->addUploadElement($name);
1763 case 'RichTextEditor':
1764 return $this->add('wysiwyg', $name, $label, $props, $required);
1767 return $this->addEntityRef($name, $label, $props, $required);
1770 $props['size'] = $props['size'] ??
60;
1771 return $this->add('password', $name, $label, $props, $required);
1773 // Check datatypes of fields
1777 //case read only fields
1779 throw new Exception("Unsupported html-element " . $widget);
1784 * Add a widget for selecting/editing/creating/copying a profile form
1786 * @param string $name
1787 * HTML form-element name.
1788 * @param string $label
1790 * @param string $allowCoreTypes
1791 * Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'.
1792 * @param string $allowSubTypes
1793 * Only present a UFGroup if its group_type is compatible with $allowSubypes.
1794 * @param array $entities
1795 * @param bool $default
1797 * @param string $usedFor
1799 public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) {
1801 // FIXME: Instead of adhoc serialization, use a single json_encode()
1802 CRM_UF_Page_ProfileEditor
::registerProfileScripts();
1803 CRM_UF_Page_ProfileEditor
::registerSchemas(CRM_Utils_Array
::collect('entity_type', $entities));
1804 $this->add('text', $name, $label, [
1805 'class' => 'crm-profile-selector',
1806 // Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML
1807 'data-group-type' => CRM_Core_BAO_UFGroup
::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'),
1808 'data-entities' => json_encode($entities),
1810 'data-default' => $default,
1811 'data-usedfor' => json_encode($usedFor),
1818 public function getRootTitle() {
1825 public function getCompleteTitle() {
1826 return $this->getRootTitle() . $this->getTitle();
1830 * @return CRM_Core_Smarty
1832 public static function &getTemplate() {
1833 return self
::$_template;
1837 * @param $elementName
1839 public function addUploadElement($elementName) {
1840 $uploadNames = $this->get('uploadNames');
1841 if (!$uploadNames) {
1844 if (is_array($elementName)) {
1845 foreach ($elementName as $name) {
1846 if (!in_array($name, $uploadNames)) {
1847 $uploadNames[] = $name;
1852 if (!in_array($elementName, $uploadNames)) {
1853 $uploadNames[] = $elementName;
1856 $this->set('uploadNames', $uploadNames);
1858 $config = CRM_Core_Config
::singleton();
1859 if (!empty($uploadNames)) {
1860 $this->controller
->addUploadAction($config->customFileUploadDir
, $uploadNames);
1869 public function getVar($name) {
1870 return $this->$name ??
NULL;
1877 public function setVar($name, $value) {
1878 $this->$name = $value;
1885 * Use $this->add('datepicker', ...) instead.
1887 * @param string $name
1888 * Name of the element.
1889 * @param string $label
1890 * Label of the element.
1891 * @param bool $required
1893 * @param array $attributes
1896 public function addDate($name, $label, $required = FALSE, $attributes = NULL) {
1897 if (!empty($attributes['formatType'])) {
1898 // get actual format
1899 $params = ['name' => $attributes['formatType']];
1902 // cache date information
1904 $key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']);
1905 if (empty($dateFormat[$key])) {
1906 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
1907 $dateFormat[$key] = $values;
1910 $values = $dateFormat[$key];
1913 if ($values['date_format']) {
1914 $attributes['format'] = $values['date_format'];
1917 if (!empty($values['time_format'])) {
1918 $attributes['timeFormat'] = $values['time_format'];
1920 $attributes['startOffset'] = $values['start'];
1921 $attributes['endOffset'] = $values['end'];
1924 $config = CRM_Core_Config
::singleton();
1925 if (empty($attributes['format'])) {
1926 $attributes['format'] = $config->dateInputFormat
;
1929 if (!isset($attributes['startOffset'])) {
1930 $attributes['startOffset'] = 10;
1933 if (!isset($attributes['endOffset'])) {
1934 $attributes['endOffset'] = 10;
1937 $this->add('text', $name, $label, $attributes);
1939 if (!empty($attributes['addTime']) ||
!empty($attributes['timeFormat'])) {
1941 if (!isset($attributes['timeFormat'])) {
1942 $timeFormat = $config->timeInputFormat
;
1945 $timeFormat = $attributes['timeFormat'];
1948 // 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively
1950 $show24Hours = TRUE;
1951 if ($timeFormat == 1) {
1952 $show24Hours = FALSE;
1955 //CRM-6664 -we are having time element name
1956 //in either flat string or an array format.
1957 $elementName = $name . '_time';
1958 if (substr($name, -1) == ']') {
1959 $elementName = substr($name, 0, strlen($name) - 1) . '_time]';
1962 $this->add('text', $elementName, ts('Time'), ['timeFormat' => $show24Hours]);
1967 $this->addRule($name, ts('Please select %1', [1 => $label]), 'required');
1968 if (!empty($attributes['addTime']) && !empty($attributes['addTimeRequired'])) {
1969 $this->addRule($elementName, ts('Please enter a time.'), 'required');
1975 * Function that will add date and time.
1978 * Use $this->add('datepicker', ...) instead.
1980 * @param string $name
1981 * @param string $label
1982 * @param bool $required
1983 * @param null $attributes
1985 public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
1986 $addTime = ['addTime' => TRUE];
1987 if (is_array($attributes)) {
1988 $attributes = array_merge($attributes, $addTime);
1991 $attributes = $addTime;
1994 $this->addDate($name, $label, $required, $attributes);
1998 * Add a currency and money element to the form.
2000 * @param string $name
2001 * @param string $label
2002 * @param bool $required
2003 * @param null $attributes
2004 * @param bool $addCurrency
2005 * @param string $currencyName
2006 * @param null $defaultCurrency
2007 * @param bool $freezeCurrency
2009 * @return \HTML_QuickForm_Element
2011 public function addMoney(
2016 $addCurrency = TRUE,
2017 $currencyName = 'currency',
2018 $defaultCurrency = NULL,
2019 $freezeCurrency = FALSE
2021 $element = $this->add('text', $name, $label, $attributes, $required);
2022 $this->addRule($name, ts('Please enter a valid amount.'), 'money');
2025 $ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency);
2032 * Add currency element to the form.
2034 * @param string $name
2035 * @param null $label
2036 * @param bool $required
2037 * @param string $defaultCurrency
2038 * @param bool $freezeCurrency
2039 * @param bool $setDefaultCurrency
2041 public function addCurrency(
2045 $defaultCurrency = NULL,
2046 $freezeCurrency = FALSE,
2047 $setDefaultCurrency = TRUE
2049 $currencies = CRM_Core_OptionGroup
::values('currencies_enabled');
2050 if (!empty($defaultCurrency) && !array_key_exists($defaultCurrency, $currencies)) {
2051 Civi
::log()->warning('addCurrency: Currency ' . $defaultCurrency . ' is disabled but still in use!');
2052 $currencies[$defaultCurrency] = $defaultCurrency;
2054 $options = ['class' => 'crm-select2 eight'];
2056 $currencies = ['' => ''] +
$currencies;
2057 $options['placeholder'] = ts('- none -');
2059 $ele = $this->add('select', $name, $label, $currencies, $required, $options);
2060 if ($freezeCurrency) {
2063 if (!$defaultCurrency) {
2064 $config = CRM_Core_Config
::singleton();
2065 $defaultCurrency = $config->defaultCurrency
;
2067 // In some case, setting currency field by default might override the default value
2068 // as encountered in CRM-20527 for batch data entry
2069 if ($setDefaultCurrency) {
2070 $this->setDefaults([$name => $defaultCurrency]);
2075 * Create a single or multiple entity ref field.
2076 * @param string $name
2077 * @param string $label
2078 * @param array $props
2079 * Mix of html and widget properties, including:.
2080 * - select - params to give to select2 widget
2081 * - entity - defaults to Contact
2082 * - create - can the user create a new entity on-the-fly?
2083 * Set to TRUE if entity is contact and you want the default profiles,
2084 * or pass in your own set of links. @see CRM_Campaign_BAO_Campaign::getEntityRefCreateLinks for format
2085 * note that permissions are checked automatically
2086 * - api - array of settings for the getlist api wrapper
2087 * note that it accepts a 'params' setting which will be passed to the underlying api
2088 * - placeholder - string
2090 * - class, etc. - other html properties
2091 * @param bool $required
2093 * @return HTML_QuickForm_Element
2095 public function addEntityRef($name, $label = '', $props = [], $required = FALSE) {
2096 // Default properties
2097 $props['api'] = CRM_Utils_Array
::value('api', $props, []);
2098 $props['entity'] = CRM_Core_DAO_AllCoreTables
::convertEntityNameToCamel($props['entity'] ??
'Contact');
2099 $props['class'] = ltrim(($props['class'] ??
'') . ' crm-form-entityref');
2101 if (array_key_exists('create', $props) && empty($props['create'])) {
2102 unset($props['create']);
2105 $props['placeholder'] = $props['placeholder'] ?? self
::selectOrAnyPlaceholder($props, $required);
2108 if (!empty($props['multiple'])) {
2109 $defaults['multiple'] = TRUE;
2111 $props['select'] = CRM_Utils_Array
::value('select', $props, []) +
$defaults;
2113 $this->formatReferenceFieldAttributes($props, get_class($this));
2114 return $this->add('text', $name, $label, $props, $required);
2118 * @param array $props
2119 * @param string $formName
2121 private function formatReferenceFieldAttributes(&$props, $formName) {
2122 CRM_Utils_Hook
::alterEntityRefParams($props, $formName);
2123 $props['data-select-params'] = json_encode($props['select']);
2124 $props['data-api-params'] = $props['api'] ?
json_encode($props['api']) : NULL;
2125 $props['data-api-entity'] = $props['entity'];
2126 if (!empty($props['create'])) {
2127 $props['data-create-links'] = json_encode($props['create']);
2129 CRM_Utils_Array
::remove($props, 'multiple', 'select', 'api', 'entity', 'create');
2133 * Convert all date fields within the params to mysql date ready for the
2134 * BAO layer. In this case fields are checked against the $_datefields defined for the form
2135 * and if time is defined it is incorporated
2137 * @param array $params
2138 * Input params from the form.
2140 * @todo it would probably be better to work on $this->_params than a passed array
2141 * @todo standardise the format which dates are passed to the BAO layer in & remove date
2144 public function convertDateFieldsToMySQL(&$params) {
2145 foreach ($this->_dateFields
as $fieldName => $specs) {
2146 if (!empty($params[$fieldName])) {
2147 $params[$fieldName] = CRM_Utils_Date
::isoToMysql(
2148 CRM_Utils_Date
::processDate(
2149 $params[$fieldName],
2150 CRM_Utils_Array
::value("{$fieldName}_time", $params), TRUE)
2154 if (isset($specs['default'])) {
2155 $params[$fieldName] = date('YmdHis', strtotime($specs['default']));
2162 * @param $elementName
2164 public function removeFileRequiredRules($elementName) {
2165 $this->_required
= array_diff($this->_required
, [$elementName]);
2166 if (isset($this->_rules
[$elementName])) {
2167 foreach ($this->_rules
[$elementName] as $index => $ruleInfo) {
2168 if ($ruleInfo['type'] == 'uploadedfile') {
2169 unset($this->_rules
[$elementName][$index]);
2172 if (empty($this->_rules
[$elementName])) {
2173 unset($this->_rules
[$elementName]);
2179 * Function that can be defined in Form to override or.
2180 * perform specific action on cancel action
2182 public function cancelAction() {
2186 * Helper function to verify that required fields have been filled.
2188 * Typically called within the scope of a FormRule function
2190 * @param array $fields
2191 * @param array $values
2192 * @param array $errors
2194 public static function validateMandatoryFields($fields, $values, &$errors) {
2195 foreach ($fields as $name => $fld) {
2196 if (!empty($fld['is_required']) && CRM_Utils_System
::isNull(CRM_Utils_Array
::value($name, $values))) {
2197 $errors[$name] = ts('%1 is a required field.', [1 => $fld['title']]);
2203 * Get contact if for a form object. Prioritise
2204 * - cid in URL if 0 (on behalf on someoneelse)
2205 * (@todo consider setting a variable if onbehalf for clarity of downstream 'if's
2206 * - logged in user id if it matches the one in the cid in the URL
2207 * - contact id validated from a checksum from a checksum
2208 * - cid from the url if the caller has ACL permission to view
2209 * - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
2213 protected function setContactID() {
2214 $tempID = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
2215 if (isset($this->_params
) && !empty($this->_params
['select_contact_id'])) {
2216 $tempID = $this->_params
['select_contact_id'];
2218 if (isset($this->_params
, $this->_params
[0]) && !empty($this->_params
[0]['select_contact_id'])) {
2219 // event form stores as an indexed array, contribution form not so much...
2220 $tempID = $this->_params
[0]['select_contact_id'];
2223 // force to ignore the authenticated user
2224 if ($tempID === '0' ||
$tempID === 0) {
2225 // we set the cid on the form so that this will be retained for the Confirm page
2226 // in the multi-page form & prevent us returning the $userID when this is called
2228 // we don't really need to set it when $tempID is set because the params have that stored
2229 $this->set('cid', 0);
2230 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2231 return (int) $tempID;
2234 $userID = $this->getLoggedInUserContactID();
2236 if (!is_null($tempID) && $tempID === $userID) {
2237 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2238 return (int) $userID;
2241 //check if this is a checksum authentication
2242 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
2243 if ($userChecksum) {
2244 //check for anonymous user.
2245 $validUser = CRM_Contact_BAO_Contact_Utils
::validChecksum($tempID, $userChecksum);
2247 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2248 CRM_Core_Resources
::singleton()->addVars('coreForm', ['checksum' => $userChecksum]);
2252 // check if user has permission, CRM-12062
2253 elseif ($tempID && CRM_Contact_BAO_Contact_Permission
::allow($tempID)) {
2254 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
2257 if (is_numeric($userID)) {
2258 CRM_Core_Resources
::singleton()->addVars('coreForm', ['contact_id' => (int) $userID]);
2260 return is_numeric($userID) ?
$userID : NULL;
2264 * Get the contact id that the form is being submitted for.
2268 public function getContactID() {
2269 return $this->setContactID();
2273 * Get the contact id of the logged in user.
2277 public function getLoggedInUserContactID() {
2278 // check if the user is logged in and has a contact ID
2279 $session = CRM_Core_Session
::singleton();
2280 return $session->get('userID') ?
(int) $session->get('userID') : FALSE;
2284 * Add autoselector field -if user has permission to view contacts
2285 * If adding this to a form you also need to add to the tpl e.g
2287 * {if !empty($selectable)}
2288 * <div class="crm-summary-row">
2289 * <div class="crm-label">{$form.select_contact.label}</div>
2290 * <div class="crm-content">
2291 * {$form.select_contact.html}
2296 * @param array $profiles
2297 * Ids of profiles that are on the form (to be autofilled).
2298 * @param array $autoCompleteField
2302 * - url (for ajax lookup)
2304 * @throws \CRM_Core_Exception
2305 * @todo add data attributes so we can deal with multiple instances on a form
2307 public function addAutoSelector($profiles = [], $autoCompleteField = []) {
2308 $autoCompleteField = array_merge([
2309 'id_field' => 'select_contact_id',
2310 'placeholder' => ts('Select someone else ...'),
2311 'show_hide' => TRUE,
2312 'api' => ['params' => ['contact_type' => 'Individual']],
2313 ], $autoCompleteField);
2315 if ($this->canUseAjaxContactLookups()) {
2316 $this->assign('selectable', $autoCompleteField['id_field']);
2317 $this->addEntityRef($autoCompleteField['id_field'], NULL, [
2318 'placeholder' => $autoCompleteField['placeholder'],
2319 'api' => $autoCompleteField['api'],
2322 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/AlternateContactSelector.js', 1, 'html-header')
2324 'form' => ['autocompletes' => $autoCompleteField],
2325 'ids' => ['profile' => $profiles],
2332 public function canUseAjaxContactLookups() {
2333 if (0 < (civicrm_api3('contact', 'getcount', ['check_permissions' => 1])) &&
2334 CRM_Core_Permission
::check([['access AJAX API', 'access CiviCRM']])
2341 * Add the options appropriate to cid = zero - ie. autocomplete
2343 * @todo there is considerable code duplication between the contribution forms & event forms. It is apparent
2344 * that small pieces of duplication are not being refactored into separate functions because their only shared parent
2345 * is this form. Inserting a class FrontEndForm.php between the contribution & event & this class would allow functions like this
2346 * and a dozen other small ones to be refactored into a shared parent with the reduction of much code duplication
2348 public function addCIDZeroOptions() {
2349 $this->assign('nocid', TRUE);
2351 if ($this->_values
['custom_pre_id']) {
2352 $profiles[] = $this->_values
['custom_pre_id'];
2354 if ($this->_values
['custom_post_id']) {
2355 $profiles = array_merge($profiles, (array) $this->_values
['custom_post_id']);
2357 $profiles[] = 'billing';
2358 if (!empty($this->_values
)) {
2359 $this->addAutoSelector($profiles);
2364 * Set default values on form for given contact (or no contact defaults)
2366 * @param mixed $profile_id
2367 * (can be id, or profile name).
2368 * @param int $contactID
2372 public function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) {
2374 $defaults = civicrm_api3('profile', 'getsingle', [
2375 'profile_id' => (array) $profile_id,
2376 'contact_id' => $contactID,
2380 catch (Exception
$e) {
2381 // the try catch block gives us silent failure -not 100% sure this is a good idea
2382 // as silent failures are often worse than noisy ones
2388 * Sets form attribute.
2391 public function preventAjaxSubmit() {
2392 $this->setAttribute('data-no-ajax-submit', 'true');
2396 * Sets form attribute.
2399 public function allowAjaxSubmit() {
2400 $this->removeAttribute('data-no-ajax-submit');
2404 * Sets page title based on entity and action.
2405 * @param string $entityLabel
2407 public function setPageTitle($entityLabel) {
2408 switch ($this->_action
) {
2409 case CRM_Core_Action
::ADD
:
2410 CRM_Utils_System
::setTitle(ts('New %1', [1 => $entityLabel]));
2413 case CRM_Core_Action
::UPDATE
:
2414 CRM_Utils_System
::setTitle(ts('Edit %1', [1 => $entityLabel]));
2417 case CRM_Core_Action
::VIEW
:
2418 case CRM_Core_Action
::PREVIEW
:
2419 CRM_Utils_System
::setTitle(ts('View %1', [1 => $entityLabel]));
2422 case CRM_Core_Action
::DELETE
:
2423 CRM_Utils_System
::setTitle(ts('Delete %1', [1 => $entityLabel]));
2429 * Create a chain-select target field. All settings are optional; the defaults usually work.
2431 * @param string $elementName
2432 * @param array $settings
2434 * @return HTML_QuickForm_Element
2436 public function addChainSelect($elementName, $settings = []) {
2437 $label = strpos($elementName, 'rovince') ? CRM_Core_DAO_StateProvince
::getEntityTitle() : CRM_Core_DAO_County
::getEntityTitle();
2438 $props = $settings +
= [
2439 'control_field' => str_replace(['state_province', 'StateProvince', 'county', 'County'], [
2445 'data-callback' => strpos($elementName, 'rovince') ?
'civicrm/ajax/jqState' : 'civicrm/ajax/jqCounty',
2447 'data-empty-prompt' => strpos($elementName, 'rovince') ?
ts('Choose country first') : ts('Choose state first'),
2448 'data-none-prompt' => ts('- N/A -'),
2449 'multiple' => FALSE,
2450 'required' => FALSE,
2451 'placeholder' => ts('- select %1 -', [1 => $label]),
2453 CRM_Utils_Array
::remove($props, 'label', 'required', 'control_field', 'context');
2454 $props['class'] = (empty($props['class']) ?
'' : "{$props['class']} ") . 'crm-select2';
2455 $props['data-select-prompt'] = $props['placeholder'];
2456 $props['data-name'] = $elementName;
2458 $this->_chainSelectFields
[$settings['control_field']] = $elementName;
2460 // Passing NULL instead of an array of options
2461 // CRM-15225 - normally QF will reject any selected values that are not part of the field's options, but due to a
2462 // quirk in our patched version of HTML_QuickForm_select, this doesn't happen if the options are NULL
2463 // which seems a bit dirty but it allows our dynamically-popuplated select element to function as expected.
2464 return $this->add('select', $elementName, $settings['label'], NULL, $settings['required'], $props);
2468 * Add actions menu to results form.
2470 * @param array $tasks
2472 public function addTaskMenu($tasks) {
2473 if (is_array($tasks) && !empty($tasks)) {
2474 // Set constants means this will always load with an empty value, not reloading any submitted value.
2475 // This is appropriate as it is a pseudofield.
2476 $this->setConstants(['task' => '']);
2477 $this->assign('taskMetaData', $tasks);
2478 $select = $this->add('select', 'task', NULL, ['' => ts('Actions')], FALSE, [
2479 'class' => 'crm-select2 crm-action-menu fa-check-circle-o huge crm-search-result-actions',
2482 foreach ($tasks as $key => $task) {
2484 if (isset($task['data'])) {
2485 foreach ($task['data'] as $dataKey => $dataValue) {
2486 $attributes['data-' . $dataKey] = $dataValue;
2489 $select->addOption($task['title'], $key, $attributes);
2491 if (empty($this->_actionButtonName
)) {
2492 $this->_actionButtonName
= $this->getButtonName('next', 'action');
2494 $this->assign('actionButtonName', $this->_actionButtonName
);
2495 $this->add('xbutton', $this->_actionButtonName
, ts('Go'), [
2497 'class' => 'hiddenElement crm-search-go-button',
2500 // Radio to choose "All items" or "Selected items only"
2501 $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', ['checked' => 'checked']);
2502 $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
2503 $this->assign('ts_sel_id', $selectedRowsRadio->_attributes
['id']);
2504 $this->assign('ts_all_id', $allRowsRadio->_attributes
['id']);
2506 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header');
2511 * Set options and attributes for chain select fields based on the controlling field's value
2513 private function preProcessChainSelectFields() {
2514 foreach ($this->_chainSelectFields
as $control => $target) {
2515 // The 'target' might get missing if extensions do removeElement() in a form hook.
2516 if ($this->elementExists($target)) {
2517 $targetField = $this->getElement($target);
2518 $targetType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ?
'county' : 'stateProvince';
2520 // If the control field is on the form, setup chain-select and dynamically populate options
2521 if ($this->elementExists($control)) {
2522 $controlField = $this->getElement($control);
2523 $controlType = $targetType == 'county' ?
'stateProvince' : 'country';
2525 $targetField->setAttribute('class', $targetField->getAttribute('class') . ' crm-chain-select-target');
2527 $css = (string) $controlField->getAttribute('class');
2528 $controlField->updateAttributes([
2529 'class' => ($css ?
"$css " : 'crm-select2 ') . 'crm-chain-select-control',
2530 'data-target' => $target,
2532 $controlValue = $controlField->getValue();
2533 if ($controlValue) {
2534 $options = CRM_Core_BAO_Location
::getChainSelectValues($controlValue, $controlType, TRUE);
2536 $targetField->setAttribute('placeholder', $targetField->getAttribute('data-none-prompt'));
2540 $targetField->setAttribute('placeholder', $targetField->getAttribute('data-empty-prompt'));
2541 $targetField->setAttribute('disabled', 'disabled');
2544 // Control field not present - fall back to loading default options
2546 $options = CRM_Core_PseudoConstant
::$targetType();
2548 if (!$targetField->getAttribute('multiple')) {
2549 $options = ['' => $targetField->getAttribute('placeholder')] +
$options;
2550 $targetField->removeAttribute('placeholder');
2552 $targetField->_options
= [];
2553 $targetField->loadArray($options);
2559 * Validate country / state / county match and suppress unwanted "required" errors
2561 private function validateChainSelectFields() {
2562 foreach ($this->_chainSelectFields
as $control => $target) {
2563 if ($this->elementExists($control) && $this->elementExists($target)) {
2564 $controlValue = (array) $this->getElementValue($control);
2565 $targetField = $this->getElement($target);
2566 $controlType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ?
'stateProvince' : 'country';
2567 $targetValue = array_filter((array) $targetField->getValue());
2568 if ($targetValue ||
$this->getElementError($target)) {
2569 $options = CRM_Core_BAO_Location
::getChainSelectValues($controlValue, $controlType, TRUE);
2571 if (!array_intersect($targetValue, array_keys($options))) {
2572 $this->setElementError($target, $controlType == 'country' ?
ts('State/Province does not match the selected Country') : ts('County does not match the selected State/Province'));
2575 // Suppress "required" error for field if it has no options
2576 elseif (!$options) {
2577 $this->setElementError($target, NULL);
2585 * Assign billing name to the template.
2587 * @param array $params
2588 * Form input params, default to $this->_params.
2592 public function assignBillingName($params = []) {
2594 if (empty($params)) {
2595 $params = $this->_params
;
2597 if (!empty($params['billing_first_name'])) {
2598 $name = $params['billing_first_name'];
2601 if (!empty($params['billing_middle_name'])) {
2602 $name .= " {$params['billing_middle_name']}";
2605 if (!empty($params['billing_last_name'])) {
2606 $name .= " {$params['billing_last_name']}";
2608 $name = trim($name);
2609 $this->assign('billingName', $name);
2614 * Get the currency for the form.
2616 * @todo this should be overriden on the forms rather than having this
2617 * historic, possible handling in here. As we clean that up we should
2618 * add deprecation notices into here.
2620 * @param array $submittedValues
2621 * Array allowed so forms inheriting this class do not break.
2622 * Ideally we would make a clear standard around how submitted values
2623 * are stored (is $this->_values consistently doing that?).
2627 public function getCurrency($submittedValues = []) {
2628 $currency = $this->_values
['currency'] ??
NULL;
2629 // For event forms, currency is in a different spot
2630 if (empty($currency)) {
2631 $currency = CRM_Utils_Array
::value('currency', CRM_Utils_Array
::value('event', $this->_values
));
2633 if (empty($currency)) {
2634 $currency = CRM_Utils_Request
::retrieveValue('currency', 'String');
2636 // @todo If empty there is a problem - we should probably put in a deprecation notice
2637 // to warn if that seems to be happening.
2642 * Is the form in view or edit mode.
2644 * The 'addField' function relies on the form action being one of a set list
2645 * of actions. Checking for these allows for an early return.
2649 protected function isFormInViewOrEditMode() {
2650 return $this->isFormInViewMode() ||
$this->isFormInEditMode();
2654 * Is the form in edit mode.
2656 * Helper function, notably for extensions implementing the buildForm hook,
2657 * so that they can return early.
2661 public function isFormInEditMode() {
2662 return in_array($this->_action
, [
2663 CRM_Core_Action
::UPDATE
,
2664 CRM_Core_Action
::ADD
,
2665 CRM_Core_Action
::BROWSE
,
2666 CRM_Core_Action
::BASIC
,
2667 CRM_Core_Action
::ADVANCED
,
2668 CRM_Core_Action
::PREVIEW
,
2673 * Is the form in view mode.
2675 * Helper function, notably for extensions implementing the buildForm hook,
2676 * so that they can return early.
2680 public function isFormInViewMode() {
2681 return $this->_action
== CRM_Core_Action
::VIEW
;
2685 * Set the active tab
2687 * @param string $default
2689 * @throws \CRM_Core_Exception
2691 public function setSelectedChild($default = NULL) {
2692 $selectedChild = CRM_Utils_Request
::retrieve('selectedChild', 'Alphanumeric', $this, FALSE, $default);
2693 if (!empty($selectedChild)) {
2694 $this->set('selectedChild', $selectedChild);
2695 $this->assign('selectedChild', $selectedChild);
2700 * Get the contact if from the url, using the checksum or the cid if it is the logged in user.
2702 * This function returns the user being validated. It is not intended to get another user
2703 * they have permission to (setContactID does do that) and can be used to check if the user is
2704 * accessing their own record.
2707 * @throws \CRM_Core_Exception
2709 protected function getContactIDIfAccessingOwnRecord() {
2710 $contactID = (int) CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
2714 if ($contactID === $this->getLoggedInUserContactID()) {
2717 $userChecksum = CRM_Utils_Request
::retrieve('cs', 'String', $this);
2718 return CRM_Contact_BAO_Contact_Utils
::validChecksum($contactID, $userChecksum) ?
$contactID : FALSE;