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

Public Member Functions

 _formatIPRanges ($ipRanges)
 
 display ($args, $request)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 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

Subscription report plugin.

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

Member Function Documentation

◆ _formatIPRanges()

SubscriptionReportPlugin::_formatIPRanges (   $ipRanges)

Pretty format IP ranges, one per line via line feeds.

Parameters
$ipRangesarray IP ranges
Returns
String Text of IP ranges formatted with newlines

Definition at line 263 of file SubscriptionReportPlugin.inc.php.

Referenced by display().

◆ display()

SubscriptionReportPlugin::display (   $args,
  $request 
)

◆ getDescription()

SubscriptionReportPlugin::getDescription ( )

Get the description text for this plugin.

Returns
String description text for this plugin

Reimplemented from Plugin.

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

◆ getDisplayName()

SubscriptionReportPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String display name of plugin

Reimplemented from Plugin.

Definition at line 41 of file SubscriptionReportPlugin.inc.php.

◆ getName()

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

◆ register()

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

References Plugin\addLocaleData().


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