BrowseBlockPlugin Class Reference

Inheritance diagram for BrowseBlockPlugin:

Public Member Functions
	getActions ($request, $actionArgs)
	getContents ($templateMgr, $request=null)
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	manage ($args, $request)
Public Member Functions inherited from BlockPlugin
	getBlockTemplateFilename ()
	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)
	getCategory ()
	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)
	isSitePlugin ()
	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

Class for browse block plugin.

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

Member Function Documentation

getActions()

BrowseBlockPlugin::getActions	(		$request,
			$actionArgs
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns

array List of LinkActions

Reimplemented from Plugin.

Definition at line 45 of file BrowseBlockPlugin.inc.php.

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

getContents()

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

Get the HTML contents of the browse block.

Parameters

$templateMgr

PKPTemplateManager

Returns

string

Reimplemented from BlockPlugin.

Definition at line 93 of file BrowseBlockPlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), and Plugin\getSetting().

getContextSpecificPluginSettingsFile()

BrowseBlockPlugin::getContextSpecificPluginSettingsFile

(

)

Install default settings on press creation.

Returns

string

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

getDescription()

BrowseBlockPlugin::getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

Definition at line 38 of file BrowseBlockPlugin.inc.php.

getDisplayName()

BrowseBlockPlugin::getDisplayName

(

)

Get the display name of this plugin.

Returns

String

Reimplemented from Plugin.

Definition at line 31 of file BrowseBlockPlugin.inc.php.

Referenced by getActions().

manage()

BrowseBlockPlugin::manage	(		$args,
			$request
	)

Reimplemented from Plugin.

Definition at line 67 of file BrowseBlockPlugin.inc.php.

References Plugin\$request.

---

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

• BrowseBlockPlugin.inc.php