Open Journal Systems  3.3.0
GoogleScholarPlugin Class Reference
Inheritance diagram for GoogleScholarPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

 getContextSpecificPluginSettingsFile ()
 
 getDescription ()
 
 getDisplayName ()
 
 register ($category, $path, $mainContextId=null)
 
 submissionView ($hookName, $args)
 
- 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 Google Scholar meta tags into submission views to facilitate indexing.

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

Member Function Documentation

◆ getContextSpecificPluginSettingsFile()

GoogleScholarPlugin::getContextSpecificPluginSettingsFile ( )

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

Returns
string

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

◆ getDescription()

GoogleScholarPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Reimplemented from Plugin.

Definition at line 185 of file GoogleScholarPlugin.inc.php.

◆ getDisplayName()

GoogleScholarPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Reimplemented from Plugin.

Definition at line 177 of file GoogleScholarPlugin.inc.php.

◆ register()

GoogleScholarPlugin::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
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger 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 GoogleScholarPlugin.inc.php.

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

◆ submissionView()

GoogleScholarPlugin::submissionView (   $hookName,
  $args 
)

Inject Google Scholar metadata into submission landing page view

Parameters
$hookNamestring
$argsarray
Returns
boolean

Definition at line 48 of file GoogleScholarPlugin.inc.php.

References $application, Plugin\$request, HookRegistry\call(), PKPApplication\get(), DAORegistry\getDAO(), AppLocale\getLocale(), and PKPTemplateManager\getManager().


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