MoodleQuickForm_editor Class Reference

Inheritance diagram for MoodleQuickForm_editor:

Collaboration diagram for MoodleQuickForm_editor:

Public Member Functions
	MoodleQuickForm_editor ($elementName=null, $elementLabel=null, $attributes=null, $options=null)
	setName ($name)
	getName ()
	setValue ($values)
	getValue ()
	getMaxbytes ()
	setMaxbytes ($maxbytes)
	getMaxfiles ()
	setMaxfiles ($num)
	getSubdirs ()
	setSubdirs ($allow)
	getFormat ()
	isRequired ()
	setHelpButton ($_helpbuttonargs, $function='_helpbutton')
	getHelpButton ()
	getElementTemplateType ()
	toHtml ()
	getFrozenHtml ()
Data Fields
	$_helpbutton = ''
	$_type = 'editor'
Protected Attributes
	$_options
	$_values = array('text'=>null, 'format'=>null, 'itemid'=>null)

---

Detailed Description

Definition at line 14 of file editor.php.

---

Member Function Documentation

getElementTemplateType

(

)

Definition at line 126 of file editor.php.

getFormat

(

)

Returns editor format

Returns:

int.

Definition at line 94 of file editor.php.

getFrozenHtml

(

)

What to display when element is frozen.

Returns:

empty string

Reimplemented from HTML_QuickForm_element.

Definition at line 284 of file editor.php.

Here is the caller graph for this function:

getHelpButton

(

)

Definition at line 122 of file editor.php.

getMaxbytes

(

)

Definition at line 64 of file editor.php.

getMaxfiles

(

)

Definition at line 73 of file editor.php.

getName

(

)

Returns the element name

Since:

1.0 public

Returns:

string

Reimplemented from HTML_QuickForm_element.

Definition at line 47 of file editor.php.

Here is the call graph for this function:

getSubdirs

(

)

Definition at line 81 of file editor.php.

getValue

(

)

Returns the value of the form element

Since:

1.0 public

Returns:

mixed

Reimplemented from HTML_QuickForm_element.

Definition at line 60 of file editor.php.

isRequired

(

)

Checks if editor used is tinymce and is required field

Returns:

true if required field.

Definition at line 103 of file editor.php.

MoodleQuickForm_editor	(	$	elementName = null,
		$	elementLabel = null,
		$	attributes = null,
		$	options = null
	)

Definition at line 22 of file editor.php.

Here is the call graph for this function:

setHelpButton	(	$	_helpbuttonargs,
		$	function = '_helpbutton'
	)

Definition at line 107 of file editor.php.

setMaxbytes

(

$

maxbytes

)

Definition at line 68 of file editor.php.

Here is the call graph for this function:

setMaxfiles

(

$

num

)

Definition at line 77 of file editor.php.

setName

(

$

name

)

Sets the input field name

Parameters:

string

$name

Input field name attribute

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 43 of file editor.php.

Here is the call graph for this function:

setSubdirs

(

$

allow

)

Definition at line 85 of file editor.php.

setValue

(

$

value

)

Sets the value of the form element

Parameters:

string

$value

Default value of the form element

Since:

1.0 public

Returns:

void

Reimplemented from HTML_QuickForm_element.

Definition at line 51 of file editor.php.

Here is the caller graph for this function:

toHtml

(

)

Abstract method. Must be extended to return the objects HTML

public

Returns:

string

print text area - TODO: add on-the-fly switching, size configuration, etc.

Reimplemented from HTML_Common.

Definition at line 134 of file editor.php.

Here is the call graph for this function:

---

Field Documentation

$_helpbutton = ''

Definition at line 15 of file editor.php.

$_options [protected]

Initial value:

 array('subdirs'=>0, 'maxbytes'=>0, 'maxfiles'=>0, 'changeformat'=>0,
                                   'context'=>null, 'noclean'=>0, 'trusttext'=>0)

Definition at line 18 of file editor.php.

$_type = 'editor'

Reimplemented from HTML_QuickForm_element.

Definition at line 17 of file editor.php.

$_values = array('text'=>null, 'format'=>null, 'itemid'=>null) [protected]

Definition at line 20 of file editor.php.

---

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

• C:/xampp/htdocs/moodle/lib/form/editor.php