CustomLocalePlugin Class Reference

Inheritance diagram for CustomLocalePlugin:

Public Member Functions
	addCustomLocale ($hookName, $args)
	callbackShowWebsiteSettingsTabs ($hookName, $args)
	getActions ($request, $actionArgs)
	getDescription ()
	getDisplayName ()
	handleLoadRequest ($hookName, $args)
	register ($category, $path, $mainContextId=null)
	setupGridHandler ($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)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	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

Definition at line 15 of file CustomLocalePlugin.inc.php.

Member Function Documentation

addCustomLocale()

CustomLocalePlugin::addCustomLocale	(		$hookName,
			$args
	)

Add custom locale data.

Parameters

$hookName	string
$args	array

Returns

boolean Hook processing status

Definition at line 141 of file CustomLocalePlugin.inc.php.

References Plugin\$request, Registry\get(), and AppLocale\registerLocaleFile().

callbackShowWebsiteSettingsTabs()

CustomLocalePlugin::callbackShowWebsiteSettingsTabs	(		$hookName,
			$args
	)

Extend the website settings tabs to include custom locale

Parameters

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

Returns

boolean Hook handling status

Definition at line 179 of file CustomLocalePlugin.inc.php.

References Plugin\getTemplateResource().

getActions()

CustomLocalePlugin::getActions	(		$request,
			$actionArgs
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns

array List of LinkActions

Reimplemented from Plugin.

Definition at line 103 of file CustomLocalePlugin.inc.php.

References Plugin\$request, and Plugin\getEnabled().

getDescription()

CustomLocalePlugin::getDescription

(

)

Get the plugin display status.

Returns

string

Reimplemented from Plugin.

Definition at line 169 of file CustomLocalePlugin.inc.php.

getDisplayName()

CustomLocalePlugin::getDisplayName

(

)

Get the plugin display name.

Returns

string

Reimplemented from Plugin.

Definition at line 161 of file CustomLocalePlugin.inc.php.

handleLoadRequest()

CustomLocalePlugin::handleLoadRequest	(		$hookName,
			$args
	)

Hook callback: Handle a request for a page load

Parameters

$hookName	string Hook name
$args	array Hook arguments

Definition at line 82 of file CustomLocalePlugin.inc.php.

References $op, Plugin\$request, PKPTemplateManager\getManager(), LazyLoadPlugin\getName(), and Plugin\getRequest().

register()

CustomLocalePlugin::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 20 of file CustomLocalePlugin.inc.php.

References Plugin\$request, PKPApplication\get(), Plugin\getEnabled(), AppLocale\getLocale(), PKPLocale\getLocaleFiles(), PKPTemplateManager\getManager(), HookRegistry\register(), and AppLocale\registerLocaleFile().

setupGridHandler()

CustomLocalePlugin::setupGridHandler	(		$hookName,
			$args
	)

Permit requests to the custom locale grid handler

Parameters

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

Definition at line 66 of file CustomLocalePlugin.inc.php.

References CustomLocaleGridHandler\setPlugin().

---

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

• CustomLocalePlugin.inc.php