XMLGalleyPlugin Class Reference
[Plugins_generic_xmlGalley]

XML Galley Plugin. More...

Inheritance diagram for XMLGalleyPlugin:

List of all members.

Public Member Functions
	_returnXMLGalleyFromArticleGalley (&$galley)
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getInstallSchemaFile ()
	getManagementVerbs ()
	getName ()
	getXMLGalley ($hookName, &$args)
	manage ($verb, $args)
	register ($category, $path)
	returnXMLGalley ($hookName, $args)
	setEnabled ($enabled)
	viewXMLGalleyFile ($hookName, $args)

---

Detailed Description

XML Galley Plugin.

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

---

Member Function Documentation

XMLGalleyPlugin._returnXMLGalleyFromArticleGalley

(

&$

galley

)

Internal function to return an ArticleXMLGalley object from an ArticleGalley object

Parameters:

$galley

ArticleGalley

Returns:

ArticleXMLGalley

Definition at line 130 of file XMLGalleyPlugin.inc.php.

Referenced by returnXMLGalley().

XMLGalleyPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from Plugin.

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

References Locale.translate().

XMLGalleyPlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

Definition at line 52 of file XMLGalleyPlugin.inc.php.

References Locale.translate().

XMLGalleyPlugin.getEnabled

(

)

Determine whether or not this plugin is enabled.

Definition at line 165 of file XMLGalleyPlugin.inc.php.

References Request.getJournal().

Referenced by getManagementVerbs(), getXMLGalley(), register(), returnXMLGalley(), and viewXMLGalleyFile().

XMLGalleyPlugin.getInstallSchemaFile

(

)

Get the filename of the ADODB schema for this plugin.

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

XMLGalleyPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

Definition at line 332 of file XMLGalleyPlugin.inc.php.

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

XMLGalleyPlugin.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 48 of file XMLGalleyPlugin.inc.php.

XMLGalleyPlugin.getXMLGalley	(	$	hookName,
		&$	args
	)

Return XML-derived galley by ID from article_xml_galleys (which does not exist in article_galleys)

Definition at line 71 of file XMLGalleyPlugin.inc.php.

References getEnabled().

XMLGalleyPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 209 of file XMLGalleyPlugin.inc.php.

References Request.getJournal(), TemplateManager.getManager(), Plugin.getPluginPath(), Request.getUserVar(), setEnabled(), Locale.translate(), and Plugin.updateSetting().

XMLGalleyPlugin.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 XMLGalleyPlugin.inc.php.

References Plugin.addLocaleData(), getEnabled(), HookRegistry.register(), and DAORegistry.registerDAO().

XMLGalleyPlugin.returnXMLGalley	(	$	hookName,
		$	args
	)

Append some special attributes to a galley identified as XML, and Return an ArticleXMLGalley object as appropriate

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

References _returnXMLGalleyFromArticleGalley(), and getEnabled().

XMLGalleyPlugin.setEnabled

(

$

enabled

)

Set the enabled/disabled state of this plugin

Definition at line 174 of file XMLGalleyPlugin.inc.php.

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

Referenced by manage().

XMLGalleyPlugin.viewXMLGalleyFile	(	$	hookName,
		$	args
	)

Return XML-derived galley as a file; basically this is a FO-rendered PDF file

Definition at line 90 of file XMLGalleyPlugin.inc.php.

References getEnabled(), and Request.getJournal().

---

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

• plugins/generic/xmlGalley/XMLGalleyPlugin.inc.php