Manual:HTMLForm Tutorial 3

• Deutsch
• English
• español
• français
• 日本語

Introduction

Using class attribute

'class' => 'HTMLTextField'

Using type attribute

'type' => 'text'

Goal

text

$formDescriptor = [
 'text' => [
 'type' => 'text',
 'label' => 'text',
 // Default value of the field
 'default' => 'Valeur par défaut',
 // Display size of field
 'size' => 10,
 // Maximum length of the input
 'maxlength'=> 7, 
 ]
];

password

$formDescriptor = [
 'password' => [
 'type' => 'password',
 'label' => 'password',
 // Default value of the field
 'default' => '',
 // Display size of field
 'size' => 16,
 // Maximum length of the input
 'maxlength'=> 16,
 ]
];

float

$formDescriptor = [
 'float' => [
 'type' => 'float',
 'label' => 'float',
 // Default value of the field (recommendation: put a float as default)
 'default' => 41.976,
 // Display size of field
 'size' => 8,
		// Maximum length of the input
 'maxlength'=> 6,
 // Minimum value for input
 'min' => 41,
 // Maximum value for input
 'max' => 43,
 ]
];

int

$formDescriptor = [
 'int' => [
 'type' => 'int',
 'label' => 'int',
 // Default value of the field (recommendation: put an int as default)
 'default' => 1789,
 // Display size of field
 'size' => 4,
		// Maximum length of the input
 'maxlength'=> 4,
		// Minimum value for input
 'min' => 0,
		// Maximum value for input
 'max' => 2011,
 ]
];

textarea

$formDescriptor = [
 'textarea' => [
 'type' => 'textarea',
 'label' => 'textarea',
		// Default value of the field
 'default' => 'Valeur par défaut',
		// Amount of rows (height of the field)
 'rows' => 3, // Display height of field 
 ]
]

select

$formDescriptor = [
 'select' => [
 'type' => 'select',
 'label' => 'select',
		// The options available within the menu (displayed => value)
 'options' => [
 'Option 0' => 0, // depends on how you see it but keys and values are kind of mixed here
 'Option 1' => 1, // "Option 1" is the displayed content, "1" is the value
 'Option 2' => 'option2id', // HTML Result = <option value="option2id">Option 2</option>
 ]
 ]
];

selectorother

$formDescriptor = [
 'selectorother' => [
 'type' => 'selectorother',
 'label' => 'selectorother',
		// The options available within the menu (displayed => value)
 'options' => [
 'Option 0' => 0,
 'Option 1' => 1,
 'Option 2' => 'option2id',
 ],
		// Maximum size of the 'other' field
 'size' => 7,
		// Maximum length of the 'other' field
 'maxlength'=> 10,
 ]
];

selectandother

$formDescriptor = [
 'selectandother' => [
 'type' => 'selectandother',
 'label' => 'selectandother',
		// The options available within the menu (displayed => value)
 'options' => [
 'Option 0' => 0,
 'Option 1' => 1,
 'Option 2' => 'option2id',
 ],
		// Maximum size of the 'other' field
 'size' => 18,
		// Maximum length of the 'other' field
 'maxlength'=> 10, 
 ]
];

multiselect

$formDescriptor = [
 'multiselect' => [
 'type' => 'multiselect',
 'label' => 'multiselect',
		// The options available within the checkboxes (displayed => value)
 'options' => [
 'Option 0' => 0,
 'Option 1' => 1,
 'Option 2' => 'option2id',
 ],
		// The options selected by default (identified by value)
 'default' => [ 0, 'option2id' ],
 ]
];

radio

$formDescriptor = [
 'radio' => [
 'type' => 'radio',
 'label' => 'radio',
		// The options available within the checkboxes (displayed => value)
 'options' => [
 'Option 0' => 0,
 'Option 1' => 1,
 'Option 2' => 'option2id',
 ],
		// The options selected by default (identified by value)
 'default' => 1,
 // If true, displays the options in a row, rather than a column
 'flatlist' => false,
 ]
];

check

$formDescriptor = [
 'mycheck' => [
 'type' => 'check',
 'label' => 'mycheck',
 ]
];

checkmatrix

$formDescriptor = [
 'checkmatrix' => [
 'type' => 'checkmatrix',
 'label' => 'checkmatrix',
 // The columns are combined with the rows to create the options available within the matrix
 // displayed => value
 'columns' => [
 // displayed => value
 'Column A' => 'A',
 'Column B' => 'B',
 'Column C' => 'C',
 ],
 // The rows are combined with the columns to create the options available within the matrix
 'rows' => [
 // displayed => value
 'Row 1' => 1,
 'Row 2' => 2,
 'Row 3' => 3,
 ],
 'force-options-on' => [ 'C-2' ], // Options to make checked and enabled (identified by values)
 'force-options-off' => [ 'C-3' ], // Options to make unchecked and disabled (identified by values)
 'tooltips' => [ 'Row 3' => 'These options are in row 3.' ], // Tooltip to add to the Row 3 row label
 'default' => [ 'A-1', 'B-3' ], // Options selected by default (identified by values)
 ]
];

info

$formDescriptor = [
 'info' => [
 'type' => 'info',
 'label' => 'info',
 // Value to display
 'default' => '<a href="https://wikipedia.org/">Wikipedia</a>',
 // If true, the above string won't be HTML escaped
 'raw' => true,
 ]
];

submit

$formDescriptor = [
 'submit' => [
 'type' => 'submit',
 'buttonlabel' => 'submit',
 ]
];

hidden

$formDescriptor = [
 'hidden' => [
 'type' => 'hidden',
 'name' => 'hidden',
 // Value to send
 'default' => 'This Intel Is Hidden',
 ]
];

tagfilter

$formDescriptor = [
 'tagFilter' => [
 'type' => 'tagfilter',
 'name' => 'tagfilter',
 'label-message' => 'tag-filter',
 ]
];

sizefilter

$formDescriptor = [
 'size' => [
 'type' => 'sizefilter',
 'name' => 'size',
 'default' => '',
 ]
];

user

$formDescriptor = [
 'username' => [
 'type' => 'user',
 'label' => 'Username:',
 'exists' => true,
 ]
];

usersmultiselect

$formDescriptor = [
 'size' => [
 'type' => 'usersmultiselect',
 'name' => 'size',
 'label' => 'Publishers:',
 'exists' => true,
 ]
];

url

$formDescriptor = [
 'urlinput' => [
 'type' => 'url',
 'name' => 'web-url',
 'label' => 'Url:',
 ]
];

title

$formDescriptor = [
 'titleinput' => [
 'type' => 'title',
 'name' => 'page-title',
 'label' => 'Title:',
 ]
];

date

$formDescriptor = [
 'dateSelector' => [
 'type' => 'date',
 'name' => 'date-input',
 'label' => 'Date:',
 ]
];

time

$formDescriptor = [
 'timeSelector' => [
 'type' => 'time',
 'name' => 'time-input',
 'label' => 'Time:',
 ]
];

datetime

$formDescriptor = [
 'datetimeSelector' => [
 'type' => 'datetime',
 'name' => 'datetime-input',
 'label' => 'Date and Time:',
 'min' => $min, // Set $min as minimum value
 'max' => $max, // Set $max as maximum value
 ]
];

email

$formDescriptor = [
 'myemail' => [
 'type' => 'email',
 'label' => 'Enter Your Email:',
 'autofocus' => true,
 'help' => 'This is the help message for myemail.',
 ]
];

limitselect

$lang = $this->getLanguage();
$formDescriptor = [
 'limit' => [
 'type' => 'limitselect',
 'name' => 'limit',
 'label' => 'Items per page',
 'options' => [
 $lang->formatNum( 20 ) => 20,
 $lang->formatNum( 50 ) => 50,
 $lang->formatNum( 70 ) => 70,
 $lang->formatNum( 100 ) => 100,
 ],
 ]
];