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/ -> editorlib.php (source)

[Source view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

Utility classes and functions for text editor integration.

Copyright: 2009 Petr Skoda {@link http://skodak.org}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 245 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

texteditor:: (3 methods):
  set_text()
  get_text()
  head_setup()

Defines 3 functions

  editors_get_preferred_editor()
  editors_get_preferred_format()
  editors_get_enabled()
  get_texteditor()
  editors_get_available()
  editors_head_setup()

Class: texteditor  - X-Ref

Base abstract text editor class.

set_text($text)   X-Ref
Set the text set for this form field. Will be called before "use_editor".

param: string $text The text for the form field.

get_text()   X-Ref
Get the text set for this form field. Can be called from "use_editor".

return: string

head_setup()   X-Ref
Setup all JS and CSS needed for editor.

return: void

Functions
Functions that are not part of a class:

editors_get_preferred_editor($format = NULL)   X-Ref
Returns users preferred editor for given format

param: int $format text format or null of none
return: texteditor object

editors_get_preferred_format()   X-Ref
Returns users preferred text format.

return: int standard text format

editors_get_enabled()   X-Ref
Returns list of enabled text editors

return: array of name=>texteditor

get_texteditor($editorname)   X-Ref
Returns instance of text editor

param: string $editorname name of editor (textarea, tiny, ...)
return: object|bool texeditor instance or false if does not exist

editors_get_available()   X-Ref
Get the list of available editors

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

editors_head_setup()   X-Ref
Setup all JS and CSS needed for editors.

return: void