interface EditorInterface (View source)

Interface that all rich-text editors must implement.

Methods

string
outputPageInlineEditor(string $key, string|null $content = null)

Generate the HTML to be placed in a page to display the inline editor.

string
outputPageComposerEditor(string $key, string $content)

Generate the HTML to be placed in a page to display the editor in composer views.

string
outputBlockEditModeEditor(string $key, string $content)

Generate the HTML to be placed in a page to display the editor when the page is in edito mode.

string
outputStandardEditor(string $key, string|null $content = null)

Generate the HTML to be placed in a page to display the editor.

setAllowSitemap(bool $allow)

Set if the editor can offer the "browse sitemap" feature.

setAllowFileManager(bool $allow)

Set if the editor can offer the "browse files" feature.

getPluginManager()

Get the plugin manager instance.

saveOptionsForm(Request $request)

Save the plugin options.

requireEditorAssets()

Build the list of required assets.

Details

string outputPageInlineEditor(string $key, string|null $content = null)

Generate the HTML to be placed in a page to display the inline editor.

Parameters

string $key the name of the field to be used to POST the editor content
string|null $content The initial value of the editor content

Return Value

string

string outputPageComposerEditor(string $key, string $content)

Generate the HTML to be placed in a page to display the editor in composer views.

Parameters

string $key the name of the field to be used to POST the editor content
string $content The initial value of the editor content

Return Value

string

string outputBlockEditModeEditor(string $key, string $content)

Generate the HTML to be placed in a page to display the editor when the page is in edito mode.

Parameters

string $key the name of the field to be used to POST the editor content
string $content The initial value of the editor content

Return Value

string

string outputStandardEditor(string $key, string|null $content = null)

Generate the HTML to be placed in a page to display the editor.

Parameters

string $key the name of the field to be used to POST the editor content
string|null $content The initial value of the editor content

Return Value

string

setAllowSitemap(bool $allow)

Set if the editor can offer the "browse sitemap" feature.

Parameters

bool $allow

setAllowFileManager(bool $allow)

Set if the editor can offer the "browse files" feature.

Parameters

bool $allow

PluginManager getPluginManager()

Get the plugin manager instance.

Return Value

PluginManager

saveOptionsForm(Request $request)

Save the plugin options.

Parameters

Request $request

requireEditorAssets()

Build the list of required assets.