Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
SubscriptionReportPlugin Class Reference
Inheritance diagram for SubscriptionReportPlugin:
ReportPlugin Plugin PKPPlugin

Public Member Functions

 _formatIPRanges ($ipRanges)
 _html2text ($html)
 display ($args, $request)
 getDescription ()
 getDisplayName ()
 getName ()
 register ($category, $path)
- Public Member Functions inherited from ReportPlugin
 display ($args, $request)
 getColumns ($metricType)
 getDefaultReportTemplates ($metricType)
 getManagementVerbs ()
 getMetricDisplayType ($metricType)
 getMetricFullName ($metricType)
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 getMetricTypes ()
 getObjectTypes ($metricType)
 getOptionalColumns ($metricType)
 manage ($verb, $args)
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 smartyPluginUrl ($params, &$smarty)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Subscription report plugin.

Definition at line 18 of file

Member Function Documentation

SubscriptionReportPlugin::_formatIPRanges (   $ipRanges)

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

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

Definition at line 285 of file

Referenced by display().

SubscriptionReportPlugin::_html2text (   $html)

Replace HTML "newline" tags (p, li, br) with line feeds. Strip all other tags.

$htmlString Input HTML string
String Text with replaced and stripped HTML tags

Definition at line 271 of file

References String\html2utf(), and String\regexp_replace().

Referenced by display().

SubscriptionReportPlugin::display (   $args,

Generate the subscription report and write CSV contents to file

$argsarray Request arguments
$requestobject Request object

Definition at line 61 of file

References _formatIPRanges(), _html2text(), String\fputcsv(), DAORegistry\getDAO(), and Request\getJournal().

SubscriptionReportPlugin::getDescription ( )

Get the description text for this plugin.

String description text for this plugin

Definition at line 52 of file

SubscriptionReportPlugin::getDisplayName ( )

Get the display name of this plugin.

String display name of plugin

Definition at line 44 of file

SubscriptionReportPlugin::getName ( )

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

String name of plugin

Definition at line 36 of file

SubscriptionReportPlugin::register (   $category,

Called as a plugin is registered to the registry

$categoryString Name of category plugin was registered to
boolean True if plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 25 of file

References PKPPlugin\addLocaleData().

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