checkBox()
checkBoxUnit()
comboBox()
comboBoxUnit()
controlUnit()
form()
getListItemId()
listItem()
mergeOptionArrays()
password()
passwordUnit()
popup()
radio()
radioUnit()
resetControlCounter()
select()
selectUnit()
spinBox()
spinBoxUnit()
submitUnit()
textBox()
textBoxUnit()
upload()
uploadUnit()
_appendClasses()
_getCheckBoxGroupHtml()
_getCheckBoxInput()
_getCheckBoxOptionHtml()
_getComboBoxGroupHtml()
_getComboBoxInput()
_getComboBoxOptionHtml()
_getControlId()
_getDataAttributesAsString()
_getDisablerHtml()
_getRadioGroupHtml()
_getRadioInput()
_getRadioOptionHtml()
_getSelectGroupHtml()
_getSelectInput()
_getSelectOptionHtml()
_getSpinBoxInput()
_getTextInput()
_getUploadInput()
_processControlChoices()
_wrapControlUnit()
__construct()
$_controlCounter
$_controlIdLog
$_listItemGroupCounter
$_oneUseId
Helper methods for the admin template functions/tags.
| package | XenForo_Template |
|---|
checkBox(string $name, array $choices, array $controlOptions) : string
stringDefault name of the chec kbox. If used, [] will be appended.
arrayChoices for the check box
arrayOptions that relate to the check box controls
stringcheckBoxUnit(string $label, string $name, array $choices, array $rowOptions, array $controlOptions) : string
stringLabel for the unit
stringDefault name of the chec kbox. If used, [] will be appended.
arrayChoices for the check box
arrayOptions that relate to the whole row
arrayOptions that relate to the check box controls
stringcomboBox(string $name, string $value, array $choices, array $controlOptions) : string
stringName of the text box
stringDefault value for the text box
arrayChoices for the select
arrayOptions that relate to the text/select controls
stringcomboBoxUnit(string $label, string $name, string $value, array $choices, array $rowOptions, array $controlOptions) : string
stringLabel for the unit
stringName of the text box
stringDefault value for the text box
arrayChoices for the select
arrayOptions that relate to the whole row
arrayOptions that relate to the text/select controls
stringcontrolUnit(string $label, array $rowOptions) : string
This does not contain any input field unless you manually include one. Note that the label will not be "for" any input.
stringLabel text
arrayCollection of options that relate to the row
stringform(string $childElements, array $options) : string
stringChild elements
arraystringgetListItemId(mixed $id) : string
mixedstringlistItem(array $controlOptions, array $popups) : string
arrayOptions relating to the item
arrayA list of popups (HTML) that belong to the item
stringList row HTMLmergeOptionArrays(array $start, array $additional, boolean $raw) : array
"Simple" form (value => label) data will be translated into a simple array format to be unambiguous.
arrayThe base array
arrayThe data to add to the base array. Ignored if not an array.
booleanIf true, escaping is not done on printable components
arraypassword(string $name, string $value, array $controlOptions) : string
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the control
stringpasswordUnit(string $label, string $name, string $value, array $rowOptions, array $controlOptions) : string
stringLabel for the row
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the row
arrayOptions that relate to the control
stringpopup(array $controlOptions, array $choices, string $wrapTag, string $extraMenuClass) : string
arrayOptions for the control
arrayChoices within the popup; each will be an li
stringTag to wrap menu in (div or ul, for example)
stringAn extra class (or multiple) set as the menu class
stringPopup HTMLradio(string $name, string $value, array $choices, array $controlOptions) : string
stringName of the radios
stringSelected value for the radio
arrayChoices for the radios
arrayOptions that relate to the radio controls
stringradioUnit(string $label, string $name, string $value, array $choices, array $rowOptions, array $controlOptions) : string
stringLabel for the unit
stringName of the radios
stringSelected value for the radio
arrayChoices for the radios
arrayOptions that relate to the whole row
arrayOptions that relate to the radio controls
stringresetControlCounter()
This may cause duplicate IDs. Primarily used for testing.
select(string $name, string $value, array $choices, array $controlOptions) : string
stringName of the select
stringSelected value for the select
arrayChoices for the select
arrayOptions that relate to the select control
stringselectUnit(string $label, string $name, string $value, array $choices, array $rowOptions, array $controlOptions) : string
stringLabel for the unit
stringName of the select
stringSelected value for the select
arrayChoices for the select
arrayOptions that relate to the whole row
arrayOptions that relate to the select control
stringspinBox(string $name, string $value, array $controlOptions) : string
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the control
stringspinBoxUnit(string $label, string $name, string $value, array $rowOptions, array $controlOptions) : string
stringLabel for the row
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the row
arrayOptions that relate to the control
stringsubmitUnit(string $childText, array $controlOptions) : string
stringOutput from text that was within the submitunit tag
arrayOptions for this control
stringtextBox(string $name, string $value, array $controlOptions) : string
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the control
stringtextBoxUnit(string $label, string $name, string $value, array $rowOptions, array $controlOptions) : string
stringLabel for the row
stringName of the text box
stringDefault value of the text box
arrayOptions that relate to the row
arrayOptions that relate to the control
stringupload(string $name, string $value, array $controlOptions) : string
stringName of the input
stringDefault value of the text box (likely ignored)
arrayOptions that relate to the control
stringuploadUnit(string $label, string $name, string $value, array $rowOptions, array $controlOptions) : string
stringLabel for the row
stringName of the input
stringDefault value of the upload box (likely ignored by browsers)
arrayOptions that relate to the row
arrayOptions that relate to the control
string_appendClasses(array $array, string $key, string $append) : array
List must be within an array.
arrayArray that contains the list
stringKey of the list
stringClasses to appended. Separate with spaces.
arrayOriginal array, updated_getCheckBoxGroupHtml(\$label $label, \$optionHtml $optionHtml) : string
At this time, optgroups are ignored.
\$labelLabel for the group
\$optionHtmlHTML for the options within the group
string_getCheckBoxInput(string $name, array $choices, array $controlOptions) : string
stringDefault name of the check box. If used, [] will be appended.
arrayChoices for the check box
arrayControl options
string_getCheckBoxOptionHtml(string $value, string $label, boolean $selected, array $extra, array $options) : string
stringValue for the option (what it submitted to the server)
stringLabel for the option (printable)
booleanWhether this option is selected
arrayExtra data about the check box
arrayParsing options
string_getComboBoxGroupHtml(\$label $label, \$optionHtml $optionHtml) : string
\$labelLabel for the group
\$optionHtmlHTML for the options within the group
string_getComboBoxInput(string $name, string $value, array $choices, array $controlOptions, string $id) : string
stringName of the select input. If multiple selections are allow, [] will be appended.
stringDefault selected option
arrayChoices for the select
arrayControl options
stringOptional ID for the input. If not specified, one will be generated.
string_getComboBoxOptionHtml(string $value, string $label) : string
stringValue for the option (what it submitted to the server)
stringLabel for the option (printable)
string_getControlId(string $name, array $controlOptions) : string
stringName of the control. Will be used to generate the ID if possible and not overridden.
string_getDataAttributesAsString(array $options) : string
The given array should be all options, not just the data array.
arrayAll options, possibly including a _data key.
stringAttributes AS string, with a leading space if there are attributes_getDisablerHtml(array $optionInfo, string $optionId) : string
arrayInformation about the option. Disablers searched for in "disabled" key.
stringID that is being used for the parent of the disabler
stringHTML for the disabled controls, if applicable_getRadioGroupHtml(\$label $label, \$optionHtml $optionHtml) : string
At this time, optgroups are ignored.
\$labelLabel for the group
\$optionHtmlHTML for the options within the group
string_getRadioInput(string $name, string $value, array $choices, array $controlOptions) : string
stringName of the radop inputs.
stringDefault selected option
arrayChoices for the radios
arrayControl options
string_getRadioOptionHtml(string $value, string $label, boolean $selected, array $extra, array $options) : string
stringValue for the option (what it submitted to the server)
stringLabel for the option (printable)
booleanWhether this option is selected
arrayExtra data about the radio
arrayParsing options
string_getSelectGroupHtml(\$label $label, \$optionHtml $optionHtml) : string
\$labelLabel for the group
\$optionHtmlHTML for the options within the group
string_getSelectInput(string $name, string $value, array $choices, array $controlOptions, string $id) : string
stringName of the select input. If multiple selections are allow, [] will be appended.
stringDefault selected option
arrayChoices for the select
arrayControl options
stringOptional ID for the input. If not specified, one will be generated.
string_getSelectOptionHtml(string $value, string $label, boolean $selected, array $extra) : string
stringValue for the option (what it submitted to the server)
stringLabel for the option (printable)
booleanWhether this option is selected
arrayExtra data about the option
string_getSpinBoxInput(string $name, string $value, array $controlOptions, string $id) : string
stringName of the input
stringDefault selected option
arrayControl options
stringOptional ID for the input. If not specified, one will be generated.
string_getTextInput(string $type, string $name, string $value, array $controlOptions, string $id) : string
Standard text inputs may span multiple rows, turning into a textarea.
stringType of input requested; either text or password
stringName of the input field. Already HTML escaped.
stringDefault value for the input field. Already HTML escaped.
arrayArray of options for the control
stringOptional ID for the input. If not specified, one will be generated.
string_getUploadInput(string $name, string $value, array $controlOptions, string $id) : string
stringName of the input
stringDefault selected option
arrayControl options
stringOptional ID for the input. If not specified, one will be generated.
string_processControlChoices(array $choices, string | array $selectedValue, array $callbacks, array $options) : string
arrayArray of choices
stringarraySelected value
arrayCallbacks. Define 2 keys: group and option
arrayExtra options to manipulate the choices.
string_wrapControlUnit(string $label, string $controlText, string $id, array $rowOptions) : string
stringRow label
stringText of the control
stringUnique ID for the control
arrayStandard row options: * hint - hint text shown under leabel * class - class to apply to whole unit * explain - text to show under control * labelHidden - boolean, if true label is not shown * html - arbitrary html to add between control and explain text
stringControl wrapped in label/row markup__construct()
Don't instantiate this object. Use it statically.
$_controlCounter : integer
$_controlIdLog
$_listItemGroupCounter : integer
$_oneUseId : null | string
Useful for generating it in one function and defering to another (possibly recursive function) to use it.
Null means it has not been set.