Open Journal Systems  3.3.0
CustomBlockManagerPlugin Class Reference
Inheritance diagram for CustomBlockManagerPlugin:
GenericPlugin LazyLoadPlugin Plugin

Public Member Functions

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

Plugin to let managers add and delete custom sidebar blocks

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

Member Function Documentation

◆ getActions()

CustomBlockManagerPlugin::getActions (   $request,
  $actionArgs 
)

Get a list of link actions for plugin management.

Parameters
requestPKPRequest
$actionArgsarray The list of action args to be included in request URLs.
Returns
array List of LinkActions

Reimplemented from Plugin.

Definition at line 97 of file CustomBlockManagerPlugin.inc.php.

References Plugin\$request, Plugin\getCategory(), getDisplayName(), Plugin\getEnabled(), and LazyLoadPlugin\getName().

◆ getDescription()

CustomBlockManagerPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

CustomBlockManagerPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

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

Referenced by getActions().

◆ isSitePlugin()

CustomBlockManagerPlugin::isSitePlugin ( )

This plugin can be used site-wide or in a specific context. The isSitePlugin check is used to grant access to different users, so this plugin must return true only if the user is currently in the site-wide context.

See also
PluginGridRow::_canEdit()
Returns
boolean

Reimplemented from Plugin.

Definition at line 146 of file CustomBlockManagerPlugin.inc.php.

References PKPApplication\get().

◆ manage()

CustomBlockManagerPlugin::manage (   $args,
  $request 
)

Perform a management function.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage A JSON-encoded response

Reimplemented from Plugin.

Definition at line 125 of file CustomBlockManagerPlugin.inc.php.

References Plugin\$request, and PKPTemplateManager\getManager().

◆ register()

CustomBlockManagerPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

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

References Plugin\$request, PKPApplication\get(), Plugin\getEnabled(), Plugin\getPluginPath(), Plugin\getSetting(), Config\getVar(), PluginRegistry\register(), and HookRegistry\register().

◆ setupGridHandler()

CustomBlockManagerPlugin::setupGridHandler (   $hookName,
  $params 
)

Permit requests to the custom block grid handler

Parameters
$hookNamestring The name of the hook being invoked
$argsarray The parameters to the invoked hook

Definition at line 85 of file CustomBlockManagerPlugin.inc.php.

References LazyLoadPlugin\getName().


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