DublinCoreMetaPlugin Class Reference

Inheritance diagram for DublinCoreMetaPlugin:

Public Member Functions
	articleView ($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

Inject Dublin Core meta tags into article views to facilitate indexing.

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

Member Function Documentation

articleView()

DublinCoreMetaPlugin::articleView	(		$hookName,
			$args
	)

Inject Dublin Core metadata into article view

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 47 of file DublinCoreMetaPlugin.inc.php.

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

getContextSpecificPluginSettingsFile()

DublinCoreMetaPlugin::getContextSpecificPluginSettingsFile

(

)

Get the name of the settings file to be installed on new context creation.

Returns

string

Reimplemented from Plugin.

Definition at line 37 of file DublinCoreMetaPlugin.inc.php.

References Plugin\getPluginPath().

getDescription()

DublinCoreMetaPlugin::getDescription

(

)

Get the description of this plugin

Returns

string

Reimplemented from Plugin.

Definition at line 172 of file DublinCoreMetaPlugin.inc.php.

getDisplayName()

DublinCoreMetaPlugin::getDisplayName

(

)

Get the display name of this plugin

Returns

string

Reimplemented from Plugin.

Definition at line 164 of file DublinCoreMetaPlugin.inc.php.

register()

DublinCoreMetaPlugin::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 DublinCoreMetaPlugin.inc.php.

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

---

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

• DublinCoreMetaPlugin.inc.php