Html
Input Field Html
Generates HTML for a given set of InputField objects, which may consist of a label, tooltip, input field, or some combination thereof.
Attributes
- #[AllowDynamicProperties]
Table of Contents
Properties
| $container_selector | |
| $fields |
Methods
| __construct() | |
| generate() | Gets the HTML for displaying the currently attached configurable options |
| getContainerSelector() | Gets the selector for the element containing the configurable options |
| setContainerSelector() | Sets the selector for the element containing the configurable options |
| setFields() | Sets the InputFields that should be used for generating HTML |
Properties
$container_selector
private
mixed
$container_selector
= '.generated_fields_div'
$fields
private
InputFields
$fields
The fields for which to generate HTML
Methods
__construct()
public
__construct([InputFields $fields = null ]) : mixed
Parameters
- $fields : InputFields = null
generate()
Gets the HTML for displaying the currently attached configurable options
public
generate([string $file = null ][, string $view_dir = null ]) : string
Parameters
- $file : string = null
-
The file to use for displaying configurable options
- $view_dir : string = null
-
The directory in which to look for the configurable option display file
Return values
string —The configurable option HTML
getContainerSelector()
Gets the selector for the element containing the configurable options
public
getContainerSelector() : string
Return values
string —The element selector
setContainerSelector()
Sets the selector for the element containing the configurable options
public
setContainerSelector(string $container_selector) : mixed
Parameters
- $container_selector : string
-
The element selector
setFields()
Sets the InputFields that should be used for generating HTML
public
setFields(InputFields $fields) : mixed
Parameters
- $fields : InputFields
-
The fields for which to generate HTML