Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Attributes | List of all members
MoodleQuickForm_htmleditor Class Reference
Inheritance diagram for MoodleQuickForm_htmleditor:
MoodleQuickForm_textarea templatable

Public Member Functions

 __construct ($elementName=null, $elementLabel=null, $options=array(), $attributes=null)
 Constructor. More...
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template. More...
 
 get_force_ltr ()
 Get force LTR option. More...
 
 getElementTemplateType ()
 Slightly different container template when frozen. More...
 
 getFrozenHtml ()
 What to display when element is frozen. More...
 
 getHelpButton ()
 get html for help button More...
 
 MoodleQuickForm_htmleditor ($elementName=null, $elementLabel=null, $options=array(), $attributes=null)
 Old syntax of class constructor. More...
 
 MoodleQuickForm_textarea ($elementName=null, $elementLabel=null, $attributes=null)
 Old syntax of class constructor. More...
 
 onQuickFormEvent ($event, $arg, &$caller)
 Called by HTML_QuickForm whenever form event is made on this element. More...
 
 set_force_ltr ($value)
 Force the field to flow left-to-right. More...
 
 setHiddenLabel ($hiddenLabel)
 Sets label to be hidden. More...
 
 toHtml ()
 Returns the input field in HTML. More...
 

Public Attributes

string $_formid = ''
 Need to store id of form as we may need it for helpbutton.
 
string $_helpbutton =''
 html for help button, if empty then no help
 
bool $_hiddenLabel =false
 if true label will be hidden
 
array $_options =array('rows'=>10, 'cols'=>45, 'width'=>0,'height'=>0)
 default options for html editor, which can be overridden
 
string $_type
 defines the type of editor
 

Protected Attributes

bool $forceltr = false
 Whether to force the display of this element to flow LTR.
 

Constructor & Destructor Documentation

◆ __construct()

MoodleQuickForm_htmleditor::__construct (   $elementName = null,
  $elementLabel = null,
  $options = array(),
  $attributes = null 
)

Constructor.

Parameters
string$elementName(optional) name of the html editor
string$elementLabel(optional) editor label
array$optionsset of options to create html editor
array$attributes(optional) Either a typical HTML attribute string or an associative array

Member Function Documentation

◆ export_for_template()

MoodleQuickForm_textarea::export_for_template ( renderer_base  $output)
inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

  1. No complex types - only stdClass, array, int, string, float, bool
  2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implements templatable.

Reimplemented in MoodleQuickForm_wikieditor.

◆ get_force_ltr()

MoodleQuickForm_textarea::get_force_ltr ( )
inherited

Get force LTR option.

Return values
bool

◆ getElementTemplateType()

MoodleQuickForm_textarea::getElementTemplateType ( )
inherited

Slightly different container template when frozen.

Return values
string

◆ getFrozenHtml()

MoodleQuickForm_htmleditor::getFrozenHtml ( )

What to display when element is frozen.

Return values
string

◆ getHelpButton()

MoodleQuickForm_textarea::getHelpButton ( )
inherited

get html for help button

Return values
stringhtml for help button

◆ MoodleQuickForm_htmleditor()

MoodleQuickForm_htmleditor::MoodleQuickForm_htmleditor (   $elementName = null,
  $elementLabel = null,
  $options = array(),
  $attributes = null 
)

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

◆ MoodleQuickForm_textarea()

MoodleQuickForm_textarea::MoodleQuickForm_textarea (   $elementName = null,
  $elementLabel = null,
  $attributes = null 
)
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

◆ onQuickFormEvent()

MoodleQuickForm_textarea::onQuickFormEvent (   $event,
  $arg,
$caller 
)
inherited

Called by HTML_QuickForm whenever form event is made on this element.

Parameters
string$eventName of event
mixed$argevent arguments
object$callercalling object

◆ set_force_ltr()

MoodleQuickForm_textarea::set_force_ltr (   $value)
inherited

Force the field to flow left-to-right.

This is useful for fields such as code or configuration snippets.

Parameters
bool$valueThe value to set the option to.

◆ setHiddenLabel()

MoodleQuickForm_textarea::setHiddenLabel (   $hiddenLabel)
inherited

Sets label to be hidden.

Parameters
bool$hiddenLabelsets if label should be hidden

◆ toHtml()

MoodleQuickForm_htmleditor::toHtml ( )

Returns the input field in HTML.

Return values
string

Reimplemented from MoodleQuickForm_textarea.


The documentation for this class was generated from the following file: