Class Horde_Editor

Description

The Horde_Editor:: package provides an API to generate the code necessary for embedding javascript RTE editors in a web page.

$Horde: framework/Editor/Editor.php,v 1.8.10.14 2009/01/06 15:23:03 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Editor/Editor.php (line 17)


	
			
Direct descendents
Class Description
 class Horde_Editor_fckeditor The Horde_Editor_fckeditor:: class provides an WYSIWYG editor for use in the Horde Framework.
 class Horde_Editor_tinymce The Horde_Editor_tinymce:: class provides an WYSIWYG editor for use in the Horde Framework.
 class Horde_Editor_xinha The Horde_Editor_xinha:: class provides access to the Xinha editor for use in the Horde Framework.
Variable Summary
 string $_js
Method Summary
 array availableEditors ()
 Horde_Editor &factory (mixed $driver, [array $params = null])
 string getJS ()
 Horde_Editor &singleton (mixed $driver, [array $params = null])
Variables
string $_js = '' (line 24)

Javascript code to init the editor.

Methods
availableEditors (line 137)

List the available editors.

Can be called statically: Horde_Editor::availableEditors();

  • return: List of available editors.
  • since: Horde 3.2
array availableEditors ()
factory (line 39)

Attempts to return a concrete Horde_Editor instance based on $driver.

  • return: The newly created concrete Horde_Editor instance, or false on error.
Horde_Editor &factory (mixed $driver, [array $params = null])
  • mixed $driver: The type of concrete Horde_Editor subclass to return. If $driver is an array, then we will look in $driver[0]/lib/Driver/ for the subclass implementation named $driver[1].php.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
getJS (line 124)

Returns the JS code needed to instantiate the editor.

  • return: Javascript code.
  • since: Horde 3.2
string getJS ()
singleton (line 101)

Attempts to return a reference to a concrete Horde_Editor instance based on $driver. It will only create a new instance if no Horde_Editor instance with the same parameters currently exists.

This should be used if multiple cache backends (and, thus, multiple Horde_Editor instances) are required.

This method must be invoked as: $var = &Horde_Editor::singleton()

  • return: The concrete Horde_Editor reference, or false on error.
Horde_Editor &singleton (mixed $driver, [array $params = null])
  • mixed $driver: The type of concrete Horde_Editor subclass to return. If $driver is an array, then we will look in $driver[0]/lib/Editor/ for the subclass implementation named $driver[1].php.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.

Documentation generated on Sun, 30 Jan 2011 05:17:04 +0000 by phpDocumentor 1.4.3