Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
XMLGalleyPlugin Class Reference
Inheritance diagram for XMLGalleyPlugin:

Public Member Functions

 _returnXMLGalleyFromArticleGalley (&$galley)
 getInstallSchemaFile ()
 getManagementVerbs ()
 getXMLGalley ($hookName, $args)
 manage ($verb, $args, &$message, &$messageParams)
 returnXMLGalley ($hookName, $args)
 setEnabled ($enabled)
 viewXMLGalleyFile ($hookName, $args)
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 getManagementVerbs ($verbs=array())
 manage ($verb, $args, &$message, &$messageParams)
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 getName ()
 LazyLoadPlugin ()
 register ($category, $path)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

XML Galley Plugin.

Definition at line 18 of file

Member Function Documentation

XMLGalleyPlugin::_returnXMLGalleyFromArticleGalley ( $galley)

Internal function to return an ArticleXMLGalley object from an ArticleGalley object


Definition at line 122 of file

References PKPPlugin\getName().

Referenced by returnXMLGalley().

XMLGalleyPlugin::getInstallSchemaFile ( )

Get the filename of the ADODB schema for this plugin.

Definition at line 55 of file

References PKPPlugin\getPluginPath().

XMLGalleyPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 191 of file

XMLGalleyPlugin::getXMLGalley (   $hookName,

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

Definition at line 63 of file

References PKPPlugin\getName().

XMLGalleyPlugin::manage (   $verb,

Execute a management verb on this plugin

$messagestring Result status message
$messageParamsarray Parameters for the message key

Definition at line 207 of file

References Request\getJournal(), PKPPlugin\getName(), PKPPlugin\getPluginPath(), Plugin\getSetting(), PKPRequest\getUserVar(), AppLocale\requireComponents(), and Plugin\updateSetting().

XMLGalleyPlugin::returnXMLGalley (   $hookName,

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

Definition at line 100 of file

References _returnXMLGalleyFromArticleGalley().

XMLGalleyPlugin::setEnabled (   $enabled)

Set the enabled/disabled state of this plugin

Definition at line 156 of file

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

XMLGalleyPlugin::viewXMLGalleyFile (   $hookName,

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

Definition at line 82 of file

References Request\getJournal(), and Plugin\getSetting().

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