PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Editor.php

Joomla! Content Management System

Copyright:	(C) 2005 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	312 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Editor:: (6 methods):
  __construct()
  getInstance()
  initialise()
  display()
  getButtons()
  _loadEditor()

Class: Editor - X-Ref

Editor class to handle WYSIWYG editors

__construct($editor = 'none', DispatcherInterface $dispatcher = null) X-Ref

Constructor

param: string $editor The editor name
param: DispatcherInterface $dispatcher The event dispatcher we're going to use

getInstance($editor = 'none') X-Ref

No description

initialise() X-Ref

Initialise the editor

return: void

display($name, $html, $width, $height, $col, $row, $buttons = true, $id = null, $asset = null, $author = null, $params = array() X-Ref

Display the editor area.

param: string   $name     The control name.
param: string   $html     The contents of the text area.
param: string   $width    The width of the text area (px or %).
param: string   $height   The height of the text area (px or %).
param: integer  $col      The number of columns for the textarea.
param: integer  $row      The number of rows for the textarea.
param: boolean  $buttons  True and the editor buttons will be displayed.
param: string   $id       An optional ID for the textarea (note: since 1.6). If not supplied the name is used.
param: string   $asset    The object asset
param: object   $author   The author.
param: array    $params   Associative array of editor parameters.
return: string

getButtons($editor, $buttons = true) X-Ref

Get the editor extended buttons (usually from plugins)

param: string $editor The name of the editor.
param: mixed $buttons Can be boolean or array, if boolean defines if the buttons are
return: array

_loadEditor($config = array() X-Ref

Load the editor

param: array $config Associative array of editor config parameters
return: mixed

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Editor/ -> Editor.php (summary)

Defines 1 class