Inheritance diagram for BrowseBySectionPlugin:

Public Member Functions
	addMenuItemTypes ($hookName, $args)

	addSectionDAOFieldNames ($hookName, $args)

	addSectionDAOLocaleFieldNames ($hookName, $args)

	addSectionFormFields ($hookName, $args)

	addSitemapURLs ($hookName, $args)

	executeSectionFormFields ($hookName, $args)

	getDescription ()

	getDisplayName ()

	initDataSectionFormFields ($hookName, $args)

	loadPageHandler ($hookName, $args)

	readSectionFormFields ($hookName, $args)

	register ($category, $path, $mainContextId=NULL)

	setMenuItemDisplayDetails ($hookName, $args)

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)

	getActions ($request, $actionArgs)

	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)

	isSitePlugin ()

	manage ($args, $request)

	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

Allow visitors to browse journal content by section.

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

Member Function Documentation

◆ addMenuItemTypes()

BrowseBySectionPlugin::addMenuItemTypes	(	$hookName,
		$args
	)

Add Navigation Menu Item types for linking to sections

Parameters

$hookName	string
$args	array [ @option array Existing menu item types ]

Definition at line 216 of file BrowseBySectionPlugin.inc.php.

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

◆ addSectionDAOFieldNames()

BrowseBySectionPlugin::addSectionDAOFieldNames	(	$hookName,
		$args
	)

Add section settings to SectionDAO

Parameters

$hookName	string
$args	array [ @option SectionDAO @option array List of additional fields ]

Definition at line 88 of file BrowseBySectionPlugin.inc.php.

◆ addSectionDAOLocaleFieldNames()

BrowseBySectionPlugin::addSectionDAOLocaleFieldNames	(	$hookName,
		$args
	)

Add localized section settings to SectionDAO

Parameters

$hookName	string
$args	array [ @option SectionDAO @option array List of additional localized fields ]

Definition at line 104 of file BrowseBySectionPlugin.inc.php.

◆ addSectionFormFields()

BrowseBySectionPlugin::addSectionFormFields	(	$hookName,
		$args
	)

Add fields to the section editing form

Parameters

$hookName	string `Templates::Manager::Sections::SectionForm::AdditionalMetadata`
$args	array [ @option array [ @option name string Hook name @option sectionId int ] @option Smarty @option string ]

Returns: bool

Definition at line 123 of file BrowseBySectionPlugin.inc.php.

References Plugin\getTemplateResource().

◆ addSitemapURLs()

BrowseBySectionPlugin::addSitemapURLs	(	$hookName,
		$args
	)

Add the browse by section URLs to the sitemap

Parameters

$hookName	string
$args	array

Returns: boolean

Definition at line 278 of file BrowseBySectionPlugin.inc.php.

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

◆ executeSectionFormFields()

BrowseBySectionPlugin::executeSectionFormFields	(	$hookName,
		$args
	)

Save additional fields in the section editing form

Parameters

$hookName	string `sectionform::execute`
$args	array [ @option SectionForm ]

Definition at line 183 of file BrowseBySectionPlugin.inc.php.

References DAORegistry\getDAO(), PKPLocale\getPrimaryLocale(), and PKPApplication\getRequest().

◆ getDescription()

BrowseBySectionPlugin::getDescription ( )

Reimplemented from Plugin.

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

◆ getDisplayName()

BrowseBySectionPlugin::getDisplayName ( )

Reimplemented from Plugin.

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

◆ initDataSectionFormFields()

BrowseBySectionPlugin::initDataSectionFormFields	(	$hookName,
		$args
	)

Initialize data when form is first loaded

Parameters

$hookName string sectionform::initData @parram $args array [ @option SectionForm ]

Definition at line 139 of file BrowseBySectionPlugin.inc.php.

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

◆ loadPageHandler()

BrowseBySectionPlugin::loadPageHandler	(	$hookName,
		$args
	)

Load the handler to deal with browse by section page requests

Parameters

$hookName	string `LoadHandler`
$args	array [ @option string page @option string op @option string sourceFile ]

Returns: bool

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

References Plugin\getEnabled().

◆ readSectionFormFields()

BrowseBySectionPlugin::readSectionFormFields	(	$hookName,
		$args
	)

Read user input from additional fields in the section editing form

Parameters

$hookName string sectionform::readUserVars @parram $args array [ @option SectionForm @option array User vars ]

Definition at line 165 of file BrowseBySectionPlugin.inc.php.

References Plugin\$request, and PKPApplication\get().

◆ register()

BrowseBySectionPlugin::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

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer 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.