Functions reference

General

__construct
$form = new Form(string $form_ID, string $layout = 'horizontal', string $attr = '', string $framework = 'bs5');
doc.
setMode
$form->setMode(string $mode);
doc.
setOptions
$form->setOptions($user_options = array());
doc.
getOptions
$form->getOptions(mixed $options);
doc.
setAction
$form->setAction(string $url, bool $add_get_vars = true);
doc.
setLayout
$form->setLayout(string $layout);
doc.
setMethod
$form->setMethod(string $method);
doc.
startFieldset
$form->startFieldset(string $legend = '', string $fieldset_attr = '', string $legend_attr = '');
doc.
endFieldset
$form->endFieldset();
doc.
startDependentFields
$form->startDependentFields($parent_field, $show_values[, $inverse = false]);
doc.
endDependentFields
$form->endDependentFields();
doc.
clear static
Form::clear(string $form_ID);
doc.
registerValues static
Form::registerValues(string $form_ID);
doc.
mergeValues static
Form::mergeValues(array $form_names_array);
doc.
testToken static
Form::testToken(string $form_ID);
doc.
validate static
Form::validate(string $form_ID);
doc.

Elements

addInput
$form->addInput(string $type, string $name, string $value = '', string $label = '', string $attr = '');
doc.
addTextarea
$form->addTextarea(string $name, string $value = '', string $label = '', string $attr = '');
doc.
addOption
$form->addOption(string $select_name, string $value, string $txt, string $group_name = '', string $attr = '');
doc.
addSelect
$form->addSelect(string $select_name, string $label = '', string $attr = '', bool $displayGroupLabels = true);
doc.
addCountrySelect
$form->addCountrySelect(string $select_name, string $label = '', string $attr = '', array $user_options = []);
doc.
addTimeSelect
$form->addTimeSelect(string $select_name, string $label = '', string $attr = '', array $user_options = []);
doc.
addRadio
$form->addRadio(string $group_name, string $label, string $value, string $attr = '');
doc.
printRadioGroup
$form->printRadioGroup(string $group_name, string $label = '', bool $inline = true, string $attr = '');
doc.
addCheckbox
$form->addCheckbox(string $group_name, string $label, string $value, string $attr = '');
doc.
printCheckboxGroup
$form->printCheckboxGroup(string $group_name, string $label = '', bool $inline = true, string $attr = '');
doc.
addBtn
$form->addBtn(string $type, string $name, string $value, string $text, string $attr = '', string $btnGroupName = '')
doc.
printBtnGroup
$form->printBtnGroup(string $btnGroupName, string $label = '')
doc.
addHtml
$form->addHtml(string $html, string $element_name = '', string $pos = 'after');
doc.

Rendering

render
$form->render(bool $debug = false, bool $display = true);
doc.
useLoadJs
$form->useLoadJs($bundle = '');
doc.
getIncludes
$form->getIncludes(string $type, bool $debug = false);
doc.
printIncludes
$form->printIncludes(string $type, bool $debug = false);
doc.
getJsCode
$form->printJsCode(bool $debug = false);
doc.
printJsCode
$form->printJsCode(bool $debug = false);
doc.

Utilities

groupElements
$form->groupElements(string $input1, $input2, ..., $input12 = '');
doc.
setCols
$form->setCols(int $label_col_number, int $field_col_number, string $breakpoint = 'sm');
doc.
addHelper
$form->addHelper(string $helper_text, string $element_name);
doc.
addAddon
$form->addAddon(string $input_name, string $addon_html, string $pos);
doc.
addHeading
$form->addHeading(string $html, string $tag_name = 'h4', string $attr = '');
doc.
addIcon
$form->addIcon(string $input_name, string $icon_html, string $pos);
doc.
addInputWrapper
$form->addInputWrapper(string $html, string $element_name);
doc.
buildAlert
Form::buildAlert(string $content_text, string $framework, string $type = 'success');
doc.
centerContent
$form->centerContent(bool $center = true, bool $stack = false);
doc.
startDiv
$form->startDiv(string $class = '', string $id = '');
doc.
endDiv
$form->endDiv();
doc.
startRow
$form->startRow(string $additional_class = '', string $id = '');
doc.
endRow
$form->endRow();
doc.
startCol
$form->startCol(int $col_number, string $breakpoint = 'sm', string $additionalClass = '', string $id = '');
doc.
endCol
$form->endCol();
doc.

Plugins

setPluginsUrl
$form->setPluginsUrl(string $forced_url = '');
doc.
addPlugin
$form->addPlugin(string $plugin_name, string $selector, string $js_config = 'default', array $plugin_settings = []);
doc.
addFileUpload
(string $name, string $value = '', string $label = '', string $attr = '', array $fileUpload_config = [], array $current_file = [])
doc.
addHcaptcha
$form->addHcaptcha(string $sitekey, string $attr = '');
doc.
addRecaptchaV3
$form->addRecaptchaV3($key);
doc.

Popover & Modal

popover
$form->popover();
doc.
modal
$form->modal(array $options = []);
doc.

Email sending

sendMail static
Form::sendMail(array $options, array $smtp_settings = []);
doc.