Open Journal Systems
3.3.0
|
Data Fields | |
$_blockName | |
$_parentPlugin | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Additional Inherited Members | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
A generic sidebar block that can be customized through the CustomBlockManagerPlugin
Definition at line 19 of file CustomBlockPlugin.inc.php.
CustomBlockPlugin::__construct | ( | $blockName, | |
$parentPlugin | |||
) |
Constructor
$blockName | string Name of this block plugin. |
$parentPlugin | CustomBlockManagerPlugin Custom block plugin management plugin. |
Definition at line 37 of file CustomBlockPlugin.inc.php.
CustomBlockPlugin::getContents | ( | $templateMgr, | |
$request = null |
|||
) |
Get the HTML contents for this block.
$templateMgr | object |
$request | PKPRequest (Optional for legacy plugins) |
Reimplemented from BlockPlugin.
Definition at line 106 of file CustomBlockPlugin.inc.php.
References Plugin\$request, AppLocale\getLocale(), getName(), and Plugin\getSetting().
CustomBlockPlugin::getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 99 of file CustomBlockPlugin.inc.php.
CustomBlockPlugin::getDisplayName | ( | ) |
Get the display name for this plugin.
Reimplemented from Plugin.
Definition at line 92 of file CustomBlockPlugin.inc.php.
CustomBlockPlugin::getEnabled | ( | $contextId = null | ) |
Determine whether the plugin is enabled.
Reimplemented from BlockPlugin.
Definition at line 84 of file CustomBlockPlugin.inc.php.
References Config\getVar().
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.
Reimplemented from Plugin.
Definition at line 77 of file CustomBlockPlugin.inc.php.
CustomBlockPlugin::getManagerPlugin | ( | ) |
Get the management plugin
Definition at line 47 of file CustomBlockPlugin.inc.php.
References $_parentPlugin.
Referenced by getPluginPath(), and getTemplatePath().
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).
Reimplemented from LazyLoadPlugin.
Definition at line 54 of file CustomBlockPlugin.inc.php.
References $_blockName.
Referenced by getContents().
CustomBlockPlugin::getPluginPath | ( | ) |
Get the path this plugin's files are located in.
Reimplemented from Plugin.
Definition at line 61 of file CustomBlockPlugin.inc.php.
References getManagerPlugin().
CustomBlockPlugin::getTemplatePath | ( | $inCore = false | ) |
Return the canonical template path of this plug-in
$inCore | Return the core template path if true. |
Reimplemented from Plugin.
Definition at line 69 of file CustomBlockPlugin.inc.php.
References getManagerPlugin().
string CustomBlockPlugin::$_blockName |
Name of this block plugin
Definition at line 24 of file CustomBlockPlugin.inc.php.
Referenced by getName().
CustomBlockManagerPlugin CustomBlockPlugin::$_parentPlugin |
Parent plugin
Definition at line 30 of file CustomBlockPlugin.inc.php.
Referenced by getManagerPlugin().