DefaultTranslationPlugin Class Reference

Inheritance diagram for DefaultTranslationPlugin:

Public Member Functions
	getDescription ()
	getDisplayName ()
	getSeq ()
	isValidLocaleFile ($hookName, $args)
	register ($category, $path, $mainContextId=null)
	translate ($hookName, $args)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	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 ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
	getPluginPath ()
&	getRequest ()
	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

Display English translation if the current UI language translation doesn't exist

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

Member Function Documentation

getDescription()

DefaultTranslationPlugin::getDescription

(

)

Reimplemented from Plugin.

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

getDisplayName()

DefaultTranslationPlugin::getDisplayName

(

)

Reimplemented from Plugin.

Definition at line 23 of file DefaultTranslationPlugin.inc.php.

getSeq()

DefaultTranslationPlugin::getSeq

(

)

Reimplemented from Plugin.

Definition at line 49 of file DefaultTranslationPlugin.inc.php.

isValidLocaleFile()

DefaultTranslationPlugin::isValidLocaleFile	(		$hookName,
			$args
	)

Hook callback: Handle requests. Consider/register also the not existing locale files.

Parameters

$hookName	string The name of the hook being invoked
$args	array The parameters to the invoked hook

Definition at line 84 of file DefaultTranslationPlugin.inc.php.

register()

DefaultTranslationPlugin::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 37 of file DefaultTranslationPlugin.inc.php.

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

translate()

DefaultTranslationPlugin::translate	(		$hookName,
			$args
	)

Hook callback: Handle requests. Show English translation if the current UI language translation doesn't exist.

Parameters

$hookName	string The name of the hook being invoked
$args	array The parameters to the invoked hook

Definition at line 59 of file DefaultTranslationPlugin.inc.php.

---

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

• DefaultTranslationPlugin.inc.php