LensGalleyPlugin Class Reference

Inheritance diagram for LensGalleyPlugin:

Public Member Functions
	_getXMLContents ($request, $galley)
	_handleOjsUrl ($matchArray)
	articleCallback ($hookName, $args)
	articleDownloadCallback ($hookName, $args)
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	getLensPath ($request)
	issueCallback ($hookName, $args)
	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 LensGalley plugin.

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

Member Function Documentation

_getXMLContents()

LensGalleyPlugin::_getXMLContents	(		$request,
			$galley
	)

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

Parameters

$request	PKPRequest
$galley	ArticleGalley

Returns

string

Definition at line 194 of file LensGalleyPlugin.inc.php.

References Plugin\$request, PKPServices\get(), and DAORegistry\getDAO().

Referenced by articleDownloadCallback().

_handleOjsUrl()

LensGalleyPlugin::_handleOjsUrl

(

$matchArray

)

Definition at line 253 of file LensGalleyPlugin.inc.php.

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

articleCallback()

LensGalleyPlugin::articleCallback	(		$hookName,
			$args
	)

Callback that renders the article galley.

Parameters

$hookName	string
$args	array

Returns

boolean

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

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

articleDownloadCallback()

LensGalleyPlugin::articleDownloadCallback	(		$hookName,
			$args
	)

Present rewritten XML.

Parameters

string	$hookName
array	$args

Definition at line 163 of file LensGalleyPlugin.inc.php.

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

getContextSpecificPluginSettingsFile()

LensGalleyPlugin::getContextSpecificPluginSettingsFile

(

)

Install default settings on journal creation.

Returns

string

Reimplemented from Plugin.

Definition at line 38 of file LensGalleyPlugin.inc.php.

References Plugin\getPluginPath().

getDescription()

LensGalleyPlugin::getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

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

getDisplayName()

LensGalleyPlugin::getDisplayName

(

)

Get the display name of this plugin.

Returns

String

Reimplemented from Plugin.

Definition at line 46 of file LensGalleyPlugin.inc.php.

getLensPath()

LensGalleyPlugin::getLensPath

(

$request

)

returns the base path for Lens JS included in this plugin.

Parameters

$request

PKPRequest

Returns

string

Definition at line 154 of file LensGalleyPlugin.inc.php.

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

Referenced by articleCallback(), and issueCallback().

issueCallback()

LensGalleyPlugin::issueCallback	(		$hookName,
			$args
	)

Callback that renders the issue galley.

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 104 of file LensGalleyPlugin.inc.php.

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

register()

LensGalleyPlugin::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 22 of file LensGalleyPlugin.inc.php.

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

---

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

• LensGalleyPlugin.inc.php