CustomLocalePlugin Class Reference

This plugin enables customization of locale strings. More...

Inheritance diagram for CustomLocalePlugin:

List of all members.

Public Member Functions
	getDescription ()
	getDisplayName ()
	getManagementVerbs ()
	getName ()
	manage ($verb, $args)
	register ($category, $path)
	smartyPluginUrl ($params, &$smarty)

---

Detailed Description

This plugin enables customization of locale strings.

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

---

Member Function Documentation

CustomLocalePlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from Plugin.

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

References Locale.translate().

CustomLocalePlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

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

References Locale.translate().

CustomLocalePlugin.getManagementVerbs

(

)

Get a list of management actions in the form of a page => value pair. The management actions from this list are passed to the manage() function when called.

Reimplemented from Plugin.

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

References Locale.translate().

CustomLocalePlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns:

String name of plugin

Reimplemented from Plugin.

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

Referenced by smartyPluginUrl().

CustomLocalePlugin.manage	(	$	verb,
		$	args
	)

Perform a management function.

Reimplemented from Plugin.

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

References CustomLocaleHandler.index().

CustomLocalePlugin.register	(	$	category,
		$	path
	)

Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.

Parameters:

	$category	String Name of category plugin was registered to
	$path	String The path the plugin was found in

Returns:

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

Reimplemented from Plugin.

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

References Plugin.addLocaleData(), FileManager.fileExists(), Request.getJournal(), Locale.getLocale(), Locale.getLocaleFiles(), Config.getVar(), and Locale.registerLocaleFile().

CustomLocalePlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

Extend the {url ...} smarty to support plugins.

Reimplemented from Plugin.

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

References Plugin.getCategory(), and getName().

---

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

• plugins/generic/customLocale/CustomLocalePlugin.inc.php