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

Public Member Functions

 addNavigationItem ($hookName, $params)
 
 getDescription ()
 
 getDisplayName ()
 
 getHandlerPath ()
 
 getManagementVerbs ()
 
 getTemplatePath ()
 
 manage ($verb, $args, &$message, &$messageParams)
 
 register ($category, $path)
 
 setBreadcrumbs ($isSubclass=false)
 
 setupBrowseHandler ($hookName, $params)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- 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

Browse by additional objects plugin class.

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

Member Function Documentation

BrowsePlugin::addNavigationItem (   $hookName,
  $params 
)

Add additional navigation items.

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

References Plugin\getSetting().

BrowsePlugin::getDescription ( )

Get the description of this plugin.

Returns
string

Definition at line 52 of file BrowsePlugin.inc.php.

BrowsePlugin::getDisplayName ( )

Get the display name of this plugin.

Returns
string

Definition at line 44 of file BrowsePlugin.inc.php.

BrowsePlugin::getHandlerPath ( )

Get the handler path for this plugin.

Definition at line 66 of file BrowsePlugin.inc.php.

References PKPPlugin\getPluginPath().

Referenced by setupBrowseHandler().

BrowsePlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 142 of file BrowsePlugin.inc.php.

BrowsePlugin::getTemplatePath ( )

Get the template path for this plugin.

Definition at line 59 of file BrowsePlugin.inc.php.

BrowsePlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)

Execute a management verb on this plugin

Parameters
$verbstring
$argsarray
$messagestring Location for the plugin to put a result msg
$messageParamsarray
Returns
boolean

Definition at line 158 of file BrowsePlugin.inc.php.

References Request\getJournal(), PKPRequest\getUserVar(), and PKPRequest\redirect().

BrowsePlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

Parameters
$categoryString Name of category plugin was registered to
Returns
boolean True if plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 27 of file BrowsePlugin.inc.php.

References HookRegistry\register().

BrowsePlugin::setBreadcrumbs (   $isSubclass = false)

Set the breadcrumbs, given the plugin's tree of items to append.

Parameters
$subclassboolean

Definition at line 119 of file BrowsePlugin.inc.php.

References Request\url().

BrowsePlugin::setupBrowseHandler (   $hookName,
  $params 
)

Enable editor pixel tags management.

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

References getHandlerPath(), PKPPlugin\getName(), and AppLocale\requireComponents().


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