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

Public Member Functions

 get_plugin ($plugin)
 Gets a named plugin object. More...
 
 get_preferred_format ()
 Returns text format preferred by this editor. More...
 
 get_supported_formats ()
 Returns array of supported text formats. More...
 
 get_text ()
 Get the text set for this form field. More...
 
 get_tinymce_base_url ()
 Equivalent to tinyMCE.baseURL value available from JavaScript, always use instead of /../ when referencing tinymce core code from moodle plugins! More...
 
 head_setup ()
 Sets up head code if necessary. More...
 
 set_text ($text)
 Set the text set for this form field. More...
 
 supported_by_browser ()
 Is the current browser supported by this editor? More...
 
 supports_repositories ()
 Does this editor support picking from repositories? More...
 
 use_editor ($elementid, array $options=null, $fpoptions=null)
 Use this editor for give element. More...
 

Static Public Member Functions

static parse_toolbar_setting ($customtoolbar)
 Parse the custom toolbar setting. More...
 

Public Attributes

string $version = '3.5.11'
 active version - this is the directory name where to find tinymce code
 

Protected Member Functions

 get_init_params ($elementid, array $options=null)
 

Protected Attributes

string $text = ''
 $text The text set to the editor in the form. More...
 

Member Function Documentation

◆ get_plugin()

tinymce_texteditor::get_plugin (   $plugin)

Gets a named plugin object.

Will cause fatal error if plugin doesn't exist. This is intended for use by plugin files themselves.

Parameters
string$pluginName of plugin e.g. 'moodleemoticon'
Return values
editor_tinymce_pluginPlugin object

◆ get_preferred_format()

tinymce_texteditor::get_preferred_format ( )

Returns text format preferred by this editor.

Return values
int

Reimplemented from texteditor.

◆ get_supported_formats()

tinymce_texteditor::get_supported_formats ( )

Returns array of supported text formats.

Return values
array

Reimplemented from texteditor.

◆ get_text()

texteditor::get_text ( )
inherited

Get the text set for this form field.

Can be called from "use_editor".

Return values
string

◆ get_tinymce_base_url()

tinymce_texteditor::get_tinymce_base_url ( )

Equivalent to tinyMCE.baseURL value available from JavaScript, always use instead of /../ when referencing tinymce core code from moodle plugins!

Return values
moodle_urlurl pointing to the root of TinyMCE javascript code.

◆ head_setup()

tinymce_texteditor::head_setup ( )

Sets up head code if necessary.

Reimplemented from texteditor.

◆ parse_toolbar_setting()

static tinymce_texteditor::parse_toolbar_setting (   $customtoolbar)
static

Parse the custom toolbar setting.

Parameters
string$customtoolbar
Return values
arraycsv toolbar lines

◆ set_text()

texteditor::set_text (   $text)
inherited

Set the text set for this form field.

Will be called before "use_editor".

Parameters
string$textThe text for the form field.

◆ supported_by_browser()

tinymce_texteditor::supported_by_browser ( )

Is the current browser supported by this editor?

Return values
bool

Reimplemented from texteditor.

◆ supports_repositories()

tinymce_texteditor::supports_repositories ( )

Does this editor support picking from repositories?

Return values
bool

Reimplemented from texteditor.

◆ use_editor()

tinymce_texteditor::use_editor (   $elementid,
array  $options = null,
  $fpoptions = null 
)

Use this editor for give element.

Parameters
string$elementid
array$options
null$fpoptions

Reimplemented from texteditor.

Member Data Documentation

◆ $text

string texteditor::$text = ''
protectedinherited

$text The text set to the editor in the form.

Since
3.0

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