Open Journal Systems  3.3.0
CustomBlockPlugin Class Reference
Inheritance diagram for CustomBlockPlugin:
BlockPlugin LazyLoadPlugin Plugin

Public Member Functions

 __construct ($blockName, $parentPlugin)
 
 getContents ($templateMgr, $request=null)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ($contextId=null)
 
 getHideManagement ()
 
 getManagerPlugin ()
 
 getName ()
 
 getPluginPath ()
 
 getTemplatePath ($inCore=false)
 
- Public Member Functions inherited from BlockPlugin
 getBlockTemplateFilename ()
 
 setEnabled ($enabled, $contextId=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 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 ()
 
 getDirName ()
 
 getEnabled ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 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)
 

Data Fields

 $_blockName
 
 $_parentPlugin
 
- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Additional Inherited Members

- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

A generic sidebar block that can be customized through the CustomBlockManagerPlugin

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

Constructor & Destructor Documentation

◆ __construct()

CustomBlockPlugin::__construct (   $blockName,
  $parentPlugin 
)

Constructor

Parameters
$blockNamestring Name of this block plugin.
$parentPluginCustomBlockManagerPlugin Custom block plugin management plugin.

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

Member Function Documentation

◆ getContents()

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

Get the HTML contents for this block.

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

Reimplemented from BlockPlugin.

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

References Plugin\$request, AppLocale\getLocale(), getName(), and Plugin\getSetting().

◆ getDescription()

CustomBlockPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

CustomBlockPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getEnabled()

CustomBlockPlugin::getEnabled (   $contextId = null)

Determine whether the plugin is enabled.

Returns
boolean

Reimplemented from BlockPlugin.

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

References Config\getVar().

◆ getHideManagement()

CustomBlockPlugin::getHideManagement ( )

Determine whether or not this plugin should be hidden from the management interface. Useful in the case of derivative plugins, i.e. when a generic plugin registers a feed plugin.

Returns
boolean

Reimplemented from Plugin.

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

◆ getManagerPlugin()

CustomBlockPlugin::getManagerPlugin ( )

Get the management plugin

Returns
CustomBlockManagerPlugin

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

References $_parentPlugin.

Referenced by getPluginPath(), and getTemplatePath().

◆ getName()

CustomBlockPlugin::getName ( )

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns
string name of plugin

Reimplemented from LazyLoadPlugin.

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

References $_blockName.

Referenced by getContents().

◆ getPluginPath()

CustomBlockPlugin::getPluginPath ( )

Get the path this plugin's files are located in.

Returns
String pathname

Reimplemented from Plugin.

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

References getManagerPlugin().

◆ getTemplatePath()

CustomBlockPlugin::getTemplatePath (   $inCore = false)

Return the canonical template path of this plug-in

Parameters
$inCoreReturn the core template path if true.
Returns
string|null

Reimplemented from Plugin.

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

References getManagerPlugin().

Field Documentation

◆ $_blockName

string CustomBlockPlugin::$_blockName

Name of this block plugin

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

Referenced by getName().

◆ $_parentPlugin

CustomBlockManagerPlugin CustomBlockPlugin::$_parentPlugin

Parent plugin

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

Referenced by getManagerPlugin().


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