HtmlArticleGalleyPlugin Class Reference

Inheritance diagram for HtmlArticleGalleyPlugin:

Public Member Functions
	_getHTMLContents ($request, $galley)
	_handleOjsUrl ($matchArray)
	articleDownloadCallback ($hookName, $args)
	articleViewCallback ($hookName, $args)
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	register ($category, $path, $mainContextId=null)
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 ()
	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

Class for HtmlArticleGalley plugin.

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

Member Function Documentation

_getHTMLContents()

HtmlArticleGalleyPlugin::_getHTMLContents	(		$request,
			$galley
	)

Return string containing the contents of the HTML file. This function performs any necessary filtering, like image URL replacement.

Parameters

$request	PKPRequest
$galley	ArticleGalley

Returns

string

Definition at line 118 of file HtmlArticleGalleyPlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), and PKPTemplateManager\getManager().

Referenced by articleDownloadCallback().

_handleOjsUrl()

HtmlArticleGalleyPlugin::_handleOjsUrl

(

$matchArray

)

Definition at line 199 of file HtmlArticleGalleyPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), and strtolower_codesafe().

articleDownloadCallback()

HtmlArticleGalleyPlugin::articleDownloadCallback	(		$hookName,
			$args
	)

Present rewritten article HTML.

Parameters

string	$hookName
array	$args

Definition at line 93 of file HtmlArticleGalleyPlugin.inc.php.

References Plugin\$request, _getHTMLContents(), HookRegistry\call(), and PKPApplication\get().

articleViewCallback()

HtmlArticleGalleyPlugin::articleViewCallback	(		$hookName,
			$args
	)

Present the article wrapper page.

Parameters

string	$hookName
array	$args

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

References Plugin\$request, PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

getContextSpecificPluginSettingsFile()

HtmlArticleGalleyPlugin::getContextSpecificPluginSettingsFile

(

)

Install default settings on journal creation.

Returns

string

Reimplemented from Plugin.

Definition at line 35 of file HtmlArticleGalleyPlugin.inc.php.

References Plugin\getPluginPath().

getDescription()

HtmlArticleGalleyPlugin::getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

Definition at line 50 of file HtmlArticleGalleyPlugin.inc.php.

getDisplayName()

HtmlArticleGalleyPlugin::getDisplayName

(

)

Get the display name of this plugin.

Returns

String

Reimplemented from Plugin.

Definition at line 43 of file HtmlArticleGalleyPlugin.inc.php.

register()

HtmlArticleGalleyPlugin::register	(		$category,
			$path,
			$mainContextId = null
	)

See also

Plugin::register()

Reimplemented from LazyLoadPlugin.

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

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

---

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

• HtmlArticleGalleyPlugin.inc.php