Horde_Editor_Ckeditor
extends Horde_Editor
in package
This driver provides the code needed to initialize the CKeditor javascript WYSIWYG editor.
Tags
Table of Contents
- $_browser : Horde_Browser
- A browser detection object.
- $_js : string
- Javascript code to init the editor.
- __construct() : mixed
- Constructor.
- getJS() : array<string|int, mixed>
- Returns the JS code needed to instantiate the editor.
- initialize() : mixed
- Initialize the editor.
- supportedByBrowser() : bool
- Does the current browser support this driver.
Properties
$_browser
A browser detection object.
protected
Horde_Browser
$_browser
$_js
Javascript code to init the editor.
protected
string
$_js
= ''
Methods
__construct()
Constructor.
public
__construct(Horde_Browser $browser) : mixed
Parameters
- $browser : Horde_Browser
Return values
mixed —getJS()
Returns the JS code needed to instantiate the editor.
public
getJS() : array<string|int, mixed>
Return values
array<string|int, mixed> —Two keys:
- files: (array) Javascript files that need to be loaded by browser.
- scrips: (array) Code that needs to be run on the browser.
initialize()
Initialize the editor.
public
initialize([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
The following configuration parameters:
- basic: (boolean) Load "basic" editor (a small javascript stub that will download the full code on demand)?
- config: (mixed) If an array, the javascript config hash used to indiciate the config for this editor instance. If a string, will be used directly as the javascript config name to use when loading (must exist elsewhere in page).
- id: (string) The ID of the text area to turn into an editor. If empty, won't automatically load the editor.
Return values
mixed —supportedByBrowser()
Does the current browser support this driver.
public
supportedByBrowser() : bool
Return values
bool —True if the browser supports the editor.