Open Journal Systems  3.3.0
ArticleReportPlugin Class Reference
Inheritance diagram for ArticleReportPlugin:
ReportPlugin Plugin

Public Member Functions

 display ($args, $request)
 
 getDecisionMessage ($decision)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getStageLabel ($stageId)
 
 register ($category, $path, $mainContextId=null)
 
- Public Member Functions inherited from ReportPlugin
 getActions ($request, $actionArgs)
 
 getColumns ($metricType)
 
 getDefaultReportTemplates ($metricTypes=null)
 
 getMetricDisplayType ($metricType)
 
 getMetricFullName ($metricType)
 
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ()
 
 getObjectTypes ($metricType)
 
 getOptionalColumns ($metricType)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCanDisable ()
 
 getCanEnable ()
 
 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

Article report plugin.

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

Member Function Documentation

◆ display()

ArticleReportPlugin::display (   $args,
  $request 
)

◆ getDecisionMessage()

ArticleReportPlugin::getDecisionMessage (   $decision)

Get decision message

Parameters
$decisionint SUBMISSION_EDITOR_DECISION_... or SUBMISSION_EDITOR_RECOMMEND_...
Returns
string

Definition at line 294 of file ArticleReportPlugin.inc.php.

Referenced by display().

◆ getDescription()

ArticleReportPlugin::getDescription ( )

Reimplemented from Plugin.

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

◆ getDisplayName()

ArticleReportPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 40 of file ArticleReportPlugin.inc.php.

◆ getName()

ArticleReportPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category.

Returns
String name of plugin

Reimplemented from Plugin.

Definition at line 33 of file ArticleReportPlugin.inc.php.

◆ getStageLabel()

ArticleReportPlugin::getStageLabel (   $stageId)

Get stage label

Parameters
$stageIdint WORKFLOW_STAGE_ID_...
Returns
string

Definition at line 275 of file ArticleReportPlugin.inc.php.

Referenced by display().

◆ register()

ArticleReportPlugin::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 Plugin.

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

References Plugin\addLocaleData().


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