TinyMCEPlugin Class Reference

Inheritance diagram for TinyMCEPlugin:

Public Member Functions
	getCanDisable ()
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	getInstallSitePluginSettingsFile ()
	register ($category, $path, $mainContextId=null)
	registerJS ($hookName, $args)
Public Member Functions inherited from LazyLoadPlugin
	getCanEnable ()
	getCurrentContextId ()
	getEnabled ($contextId=null)
	getName ()
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getLocaleFilename ($locale)
	getPluginPath ()
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	getTemplatePath ($inCore=false)
	getTemplateResource ($template=null, $inCore=false)
	import ($class)
	installContextSpecificSettings ($hookName, $args)
	installControlledVocabs ($hookName, $args)
	installData ($hookName, $args)
	installEmailTemplateData ($hookName, $args)
	installEmailTemplates ($hookName, $args)
	installFilters ($hookName, $args)
	installLocale ($hookName, $args)
	installSiteSettings ($hookName, $args)
	isSitePlugin ()
	manage ($args, $request)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

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

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

Member Function Documentation

getCanDisable()

TinyMCEPlugin::getCanDisable

(

)

Determine whether the plugin can be disabled.

Returns

boolean

Reimplemented from LazyLoadPlugin.

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

getContextSpecificPluginSettingsFile()

TinyMCEPlugin::getContextSpecificPluginSettingsFile

(

)

Get the filename of the settings data for this plugin to install when a new application context (e.g. journal, conference or press) is installed.

Subclasses using default settings should override this.

Returns

string

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

getDescription()

TinyMCEPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

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

getDisplayName()

TinyMCEPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

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

getInstallSitePluginSettingsFile()

TinyMCEPlugin::getInstallSitePluginSettingsFile

(

)

Get the filename of the settings data for this plugin to install when the system is installed (i.e. site-level plugin settings). Subclasses using default settings should override this.

Returns

string

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

register()

TinyMCEPlugin::register	(		$category,
			$path,
			$mainContextId = null
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

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

References Plugin\getEnabled(), and HookRegistry\register().

registerJS()

TinyMCEPlugin::registerJS	(		$hookName,
			$args
	)

Register the TinyMCE JavaScript file

Hooked to the the display callback in TemplateManager

Parameters

$hookName	string
$args	array

Returns

boolean

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

References Plugin\$request, Registry\get(), AppLocale\getLocale(), and Config\getVar().

---

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

• TinyMCEPlugin.inc.php