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

Public Member Functions

 CustomBlockPlugin ($blockName, $parentPluginName)
 
 getBlockContext ()
 
 getContents (&$templateMgr)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
getManagerPlugin ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getTemplatePath ()
 
 manage ($verb, $args)
 
- 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

A generic sidebar block that can be customized through the CustomBlockManagerPlugin

Definition at line 19 of file CustomBlockPlugin.inc.php.

Member Function Documentation

CustomBlockPlugin::CustomBlockPlugin (   $blockName,
  $parentPluginName 
)

Constructor

Definition at line 28 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin::getBlockContext ( )

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

Returns
int

Definition at line 183 of file CustomBlockPlugin.inc.php.

References Config\getVar().

CustomBlockPlugin::getContents ( $templateMgr)

Get the contents of the Block

Parameters
$templateMgrobject
Returns
string

Definition at line 169 of file CustomBlockPlugin.inc.php.

References Request\getJournal(), and Plugin\getSetting().

CustomBlockPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 208 of file CustomBlockPlugin.inc.php.

CustomBlockPlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
String

Definition at line 201 of file CustomBlockPlugin.inc.php.

Referenced by manage().

CustomBlockPlugin::getEnabled ( )

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

Definition at line 73 of file CustomBlockPlugin.inc.php.

References Config\getVar().

& CustomBlockPlugin::getManagerPlugin ( )

Get the management plugin

Returns
object

Definition at line 38 of file CustomBlockPlugin.inc.php.

References PluginRegistry\getPlugin().

Referenced by getPluginPath(), and getTemplatePath().

CustomBlockPlugin::getName ( )

Get the symbolic name of the plugin.

Returns
string

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

Referenced by manage().

CustomBlockPlugin::getPluginPath ( )

Override the builtin to get the correct plugin path.

Returns
string

Definition at line 55 of file CustomBlockPlugin.inc.php.

References getManagerPlugin().

CustomBlockPlugin::getSeq ( )

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

Definition at line 192 of file CustomBlockPlugin.inc.php.

References Config\getVar().

CustomBlockPlugin::getTemplatePath ( )

Override the builtin to get the correct template path.

Returns
string

Definition at line 64 of file CustomBlockPlugin.inc.php.

References getManagerPlugin().

CustomBlockPlugin::manage (   $verb,
  $args 
)

Perform management functions

Definition at line 101 of file CustomBlockPlugin.inc.php.

References PKPPlugin\getCategory(), getDisplayName(), Request\getJournal(), getName(), and Request\url().


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