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

Public Member Functions

 callbackTemplateArticlePageFooter ($hookName, $params)
 
 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 ()
 
 getContextSpecificPluginSettingsFile ()
 
 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

Plugin to recommend articles from the same author.

Definition at line 21 of file RecommendByAuthorPlugin.inc.php.

Member Function Documentation

◆ callbackTemplateArticlePageFooter()

RecommendByAuthorPlugin::callbackTemplateArticlePageFooter (   $hookName,
  $params 
)

◆ getDescription()

RecommendByAuthorPlugin::getDescription ( )
See also
Plugin::getDescription()

Reimplemented from Plugin.

Definition at line 49 of file RecommendByAuthorPlugin.inc.php.

◆ getDisplayName()

RecommendByAuthorPlugin::getDisplayName ( )
See also
Plugin::getDisplayName()

Reimplemented from Plugin.

Definition at line 42 of file RecommendByAuthorPlugin.inc.php.

◆ register()

RecommendByAuthorPlugin::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 29 of file RecommendByAuthorPlugin.inc.php.

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


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