Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/form/ -> text.php (source)

[Source view]

Text type form element Contains HTML class for a text type element

Copyright: 2006 Jamie Pratt <me@jamiep.org>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 168 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 lib/form/templatable_form_element.php

Defines 2 classes

MoodleQuickForm_text:: (2 methods):
  __construct()
  MoodleQuickForm_text()

name:: (7 methods):
  setHiddenLabel()
  freeze()
  getFrozenHtml()
  toHtml()
  getHelpButton()
  get_force_ltr()
  set_force_ltr()


Class: MoodleQuickForm_text  - X-Ref

Text type form element

HTML class for a text type element

__construct($elementName=null, $elementLabel=null, $attributes=null)   X-Ref
constructor

param: string $elementName (optional) name of the text field
param: string $elementLabel (optional) text field label
param: string $attributes (optional) Either a typical HTML attribute string or an associative array

MoodleQuickForm_text($elementName=null, $elementLabel=null, $attributes=null)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

setHiddenLabel($hiddenLabel)   X-Ref
Sets label to be hidden

param: bool $hiddenLabel sets if label should be hidden

freeze()   X-Ref
Freeze the element so that only its value is returned and set persistantfreeze to false

return: void

getFrozenHtml()   X-Ref
Returns the html to be used when the element is frozen

return: string Frozen html

toHtml()   X-Ref
Returns HTML for this form element.

return: string

getHelpButton()   X-Ref
get html for help button

return: string html for help button

get_force_ltr()   X-Ref
Get force LTR option.

return: bool

set_force_ltr($value)   X-Ref
Force the field to flow left-to-right.

This is useful for fields such as URLs, passwords, settings, etc...

param: bool $value The value to set the option to.