Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
HelpBlockPlugin Class Reference
Inheritance diagram for HelpBlockPlugin:
BlockPlugin

Public Member Functions

 getBlockContext ()
 
 getContextSpecificPluginSettingsFile ()
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getInstallSitePluginSettingsFile ()
 
 getSeq ()
 
- Public Member Functions inherited from BlockPlugin
 _getContextSpecificHomepageHook ()
 
 BlockPlugin ()
 
 callback ($hookName, $args)
 
 getBlockContext ()
 
 getBlockTemplateFilename ()
 
 getContents (&$templateMgr, $request=null)
 
getContextMap ()
 
 getSeq ()
 
 getSupportedContexts ()
 
 register ($category, $path)
 
 setBlockContext ($context)
 
 setSeq ($seq)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- 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

Class for help block plugin.

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

Member Function Documentation

HelpBlockPlugin::getBlockContext ( )

Get the block context. Overrides parent so that the plugin will be displayed during install.

Returns
int

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

References Config\getVar().

HelpBlockPlugin::getContextSpecificPluginSettingsFile ( )

Install default settings on journal creation.

Returns
string

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

References PKPPlugin\getPluginPath().

HelpBlockPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 74 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String

Definition at line 67 of file HelpBlockPlugin.inc.php.

HelpBlockPlugin::getEnabled ( )

Determine whether the plugin is enabled. Overrides parent so that the plugin will be displayed during install.

Definition at line 23 of file HelpBlockPlugin.inc.php.

References Config\getVar().

HelpBlockPlugin::getInstallSitePluginSettingsFile ( )

Install default settings on system install.

Returns
string

Definition at line 32 of file HelpBlockPlugin.inc.php.

References PKPPlugin\getPluginPath().

HelpBlockPlugin::getSeq ( )

Determine the plugin sequence. Overrides parent so that the plugin will be displayed during install.

Definition at line 58 of file HelpBlockPlugin.inc.php.

References Config\getVar().


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