Open Journal Systems  3.3.0
BlockPlugin Class Reference
Inheritance diagram for BlockPlugin:
LazyLoadPlugin Plugin AnnouncementFeedBlockPlugin BrowseBlockPlugin CustomBlockPlugin DevelopedByBlockPlugin InformationBlockPlugin LanguageToggleBlockPlugin MakeSubmissionBlockPlugin SubscriptionBlockPlugin UsageStatsOptoutBlockPlugin WebFeedBlockPlugin

Public Member Functions

 getBlockTemplateFilename ()
 
 getContents ($templateMgr, $request=null)
 
 getEnabled ($contextId=null)
 
 setEnabled ($enabled, $contextId=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getName ()
 
 register ($category, $path, $mainContextId=null)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 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

Abstract class for block plugins.

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

Member Function Documentation

◆ getBlockTemplateFilename()

BlockPlugin::getBlockTemplateFilename ( )

Get the filename of the template block. (Default behavior may be overridden through some combination of this function and the getContents function.) Returning null from this function results in an empty display.

Returns
string

Reimplemented in UsageStatsOptoutBlockPlugin.

Definition at line 51 of file BlockPlugin.inc.php.

Referenced by getContents().

◆ getContents()

BlockPlugin::getContents (   $templateMgr,
  $request = null 
)

Get the HTML contents for this block.

Parameters
$templateMgrobject
$requestPKPRequest (Optional for legacy plugins)
Returns
string

Reimplemented in CustomBlockPlugin, UsageStatsOptoutBlockPlugin, WebFeedBlockPlugin, AnnouncementFeedBlockPlugin, LanguageToggleBlockPlugin, SubscriptionBlockPlugin, InformationBlockPlugin, MakeSubmissionBlockPlugin, and BrowseBlockPlugin.

Definition at line 62 of file BlockPlugin.inc.php.

References getBlockTemplateFilename(), and Plugin\getTemplateResource().

◆ getEnabled()

BlockPlugin::getEnabled (   $contextId = null)

Determine whether or not this plugin is currently enabled.

Parameters
$contextIdint Context ID (journal/press)
Returns
boolean

Reimplemented from LazyLoadPlugin.

Reimplemented in CustomBlockPlugin, and UsageStatsOptoutBlockPlugin.

Definition at line 29 of file BlockPlugin.inc.php.

References LazyLoadPlugin\getCurrentContextId(), and Plugin\getSetting().

◆ setEnabled()

BlockPlugin::setEnabled (   $enabled,
  $contextId = null 
)

Set whether or not this plugin is currently enabled.

Parameters
$enabledboolean
$contextIdint Context ID (journal/press)

Definition at line 39 of file BlockPlugin.inc.php.

References LazyLoadPlugin\getCurrentContextId(), and Plugin\updateSetting().


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