TinyMCEPlugin Class Reference
[Plugins_generic_tinymce]

TinyMCE WYSIWYG plugin for textareas - to allow cross-browser HTML editing. More...

Inheritance diagram for TinyMCEPlugin:

List of all members.

Public Member Functions
	callback ($hookName, $args)
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getEnableFields (&$templateMgr, $page, $op)
	getInstallSitePluginSettingsFile ()
	getManagementVerbs ()
	getName ()
	getNewConferencePluginSettingsFile ()
	isMCEInstalled ()
	manage ($verb, $args, &$message)
	register ($category, $path)

---

Detailed Description

TinyMCE WYSIWYG plugin for textareas - to allow cross-browser HTML editing.

Definition at line 22 of file TinyMCEPlugin.inc.php.

---

Member Function Documentation

TinyMCEPlugin.callback	(	$	hookName,
		$	args
	)

Hook callback function for TemplateManager.display

Parameters:

	$hookName	string
	$args	array

Returns:

boolean

Definition at line 292 of file TinyMCEPlugin.inc.php.

References getEnableFields().

Referenced by register().

TinyMCEPlugin.getDescription

(

)

Get the description of this plugin

Returns:

string

Definition at line 363 of file TinyMCEPlugin.inc.php.

References isMCEInstalled().

TinyMCEPlugin.getDisplayName

(

)

Get the display name of this plugin

Returns:

string

Definition at line 355 of file TinyMCEPlugin.inc.php.

TinyMCEPlugin.getEnabled

(

)

Check whether or not this plugin is enabled

Returns:

boolean

Definition at line 380 of file TinyMCEPlugin.inc.php.

References Request.getConference(), and Plugin.getSetting().

Referenced by getManagementVerbs(), and register().

TinyMCEPlugin.getEnableFields	(	&$	templateMgr,
		$	page,
		$	op
	)

Given a $page and $op, return a list of field names for which the plugin should be used.

Parameters:

	$templateMgr	object
	$page	string The requested page
	$op	string The requested operation

Returns:

array

Definition at line 67 of file TinyMCEPlugin.inc.php.

Referenced by callback().

TinyMCEPlugin.getInstallSitePluginSettingsFile

(

)

Get the name of the settings file to be installed site-wide when OCS is installed.

Returns:

string

Definition at line 55 of file TinyMCEPlugin.inc.php.

TinyMCEPlugin.getManagementVerbs

(

)

Get a list of available management verbs for this plugin

Returns:

array

Definition at line 390 of file TinyMCEPlugin.inc.php.

References getEnabled(), and isMCEInstalled().

TinyMCEPlugin.getName

(

)

Get the symbolic name of this plugin

Returns:

string

Definition at line 347 of file TinyMCEPlugin.inc.php.

TinyMCEPlugin.getNewConferencePluginSettingsFile

(

)

Get the name of the settings file to be installed on new conference creation.

Returns:

string

Reimplemented from Plugin.

Definition at line 46 of file TinyMCEPlugin.inc.php.

TinyMCEPlugin.isMCEInstalled

(

)

Check whether or not the TinyMCE library is installed

Returns:

boolean

Definition at line 372 of file TinyMCEPlugin.inc.php.

Referenced by getDescription(), getManagementVerbs(), and register().

TinyMCEPlugin.register	(	$	category,
		$	path
	)

Register the plugin, if enabled; note that this plugin runs under both Conference and Site contexts.

Parameters:

	$category	string
	$path	string

Returns:

boolean

Reimplemented from Plugin.

Definition at line 30 of file TinyMCEPlugin.inc.php.

References callback(), getEnabled(), and isMCEInstalled().

---

The documentation for this class was generated from the following file:

• plugins/generic/tinymce/TinyMCEPlugin.inc.php

---