C:/xampp/htdocs/moodle/lib/editorlib.php File Reference

Go to the source code of this file.

Data Structures
class	texteditor
Namespaces
namespace	core
namespace	moodlecore
Functions
	editors_get_preferred_editor ($format=NULL)
	editors_get_preferred_format ()
	editors_get_enabled ()
	get_texteditor ($editorname)
	editors_get_available ()
	editors_head_setup ()
	can_use_html_editor ()

---

Function Documentation

can_use_html_editor

(

)

Does the user want and can edit using rich text html editor?

Todo:

Deprecate: eradicate completely, replace with something else in the future

Returns:

bool

Definition at line 247 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

editors_get_available

(

)

Get the list of available editors

Returns:

array Array ('editorname'=>'localised editor name')

Definition at line 159 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

editors_get_enabled

(

)

Returns list of enabled text editors

Returns:

array of name=>texteditor

Definition at line 113 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

editors_get_preferred_editor

(

$

format = NULL

)

Returns users preferred editor for given format

Parameters:

int

$format

text format or null of none

Returns:

texteditor object

Definition at line 35 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

editors_get_preferred_format

(

)

Returns users preferred text format.

Returns:

int standard text format

Definition at line 87 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

editors_head_setup

(

)

Setup all JS and CSS needed for editors.

Returns:

void

Definition at line 171 of file editorlib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_texteditor

(

$

editorname

)

Returns instance of text editor

Parameters:

string

$editorname

name of editor (textarea, tinymce, ...)

Returns:

object|bool texeditor instance or false if does not exist

Definition at line 139 of file editorlib.php.

Here is the caller graph for this function: