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 ()
	getNewJournalPluginSettingsFile ()
	isMCEInstalled ()
	manage ($verb, $args)
	register ($category, $path)

---

Detailed Description

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

Definition at line 23 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 243 of file TinyMCEPlugin.inc.php.

References Locale.getAllLocales(), getEnableFields(), Locale.getLocale(), Request.getRequestedOp(), Request.getRequestedPage(), and String.substr().

TinyMCEPlugin.getDescription

(

)

Get the description of this plugin

Returns:

string

Reimplemented from Plugin.

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

References isMCEInstalled(), and Locale.translate().

TinyMCEPlugin.getDisplayName

(

)

Get the display name of this plugin

Returns:

string

Reimplemented from Plugin.

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

References Locale.translate().

TinyMCEPlugin.getEnabled

(

)

Check whether or not this plugin is enabled

Returns:

boolean

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

References Request.getJournal().

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 68 of file TinyMCEPlugin.inc.php.

References HookRegistry.call(), and Request.getRequestedArgs().

Referenced by callback().

TinyMCEPlugin.getInstallSitePluginSettingsFile

(

)

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

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

TinyMCEPlugin.getManagementVerbs

(

)

Get a list of available management verbs for this plugin

Returns:

array

Reimplemented from Plugin.

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

References getEnabled(), isMCEInstalled(), and Locale.translate().

TinyMCEPlugin.getName

(

)

Get the symbolic name of this plugin

Returns:

string

Reimplemented from Plugin.

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

TinyMCEPlugin.getNewJournalPluginSettingsFile

(

)

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

Returns:

string

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

TinyMCEPlugin.isMCEInstalled

(

)

Check whether or not the TinyMCE library is installed

Returns:

boolean

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

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

TinyMCEPlugin.manage	(	$	verb,
		$	args
	)

Execute a management verb on this plugin

Parameters:

	$verb	string
	$args	array

Returns:

boolean

Reimplemented from Plugin.

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

References Request.getJournal(), and Plugin.updateSetting().

TinyMCEPlugin.register	(	$	category,
		$	path
	)

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

Parameters:

	$category	string
	$path	string

Returns:

boolean

Reimplemented from Plugin.

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

References Plugin.addLocaleData(), getEnabled(), isMCEInstalled(), and HookRegistry.register().

---

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

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