API Documentation
\

\Horde_Editor_Ckeditor

This driver provides the code needed to initialize the CKeditor javascript WYSIWYG editor.

Summary

Methods
Properties
Constants
__construct()
initialize()
getJS()
supportedByBrowser()
No public properties found
No constants found
No protected methods found
$_browser
$_js
N/A
No private methods found
No private properties found
N/A

Properties

$_browser

$_browser : \Horde_Browser

A browser detection object.

Type

\Horde_Browser

$_js

$_js : string

Javascript code to init the editor.

Type

string

Methods

__construct()

__construct(\Horde_Browser  $browser)

Constructor.

Parameters

\Horde_Browser $browser

initialize()

initialize(array  $params = array())

Initialize the editor.

Parameters

array $params

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.

getJS()

getJS() : array

Returns the JS code needed to instantiate the editor.

Returns

array —

Two keys:

  • files: (array) Javascript files that need to be loaded by browser.
  • scrips: (array) Code that needs to be run on the browser.

supportedByBrowser()

supportedByBrowser() : boolean

Does the current browser support this driver.

Returns

boolean —

True if the browser supports the editor.