Open Monograph Press: SettingsTabHandler Class Reference

Handle AJAX operations for tabs on settings pages, under administration or management pages. More...

Inheritance diagram for SettingsTabHandler:

List of all members.

Public Member Functions
	_getFormClassName ($classPath)
	_getTabTemplate ()
	_isManagementHandler ()
	_isTabTemplate ()
	_isValidTab ()
	authorize (&$request, $args, $roleAssignments)
	getCurrentTab ()
	getPageTabs ()
	getTabForm ()
	initialize (&$request)
	saveFormData ($args, &$request)
	setCurrentTab ($currentTab)
	setPageTabs ($pageTabs)
	SettingsTabHandler ($role)
	showTab ($args, &$request)

Detailed Description

Handle AJAX operations for tabs on settings pages, under administration or management pages.

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

Member Function Documentation

SettingsTabHandler._getFormClassName ( $ classPath )

Return the form class name based on the current tab name.

Parameters:

$classPath

string

Returns:: string

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

Referenced by getTabForm().

SettingsTabHandler._getTabTemplate ( )

Return the tab template file

Returns:: string

Definition at line 180 of file SettingsTabHandler.inc.php.

References getCurrentTab(), and getPageTabs().

Referenced by showTab().

SettingsTabHandler._isManagementHandler ( )

Check if this handles management settings.

Returns:: boolean

Definition at line 227 of file SettingsTabHandler.inc.php.

Referenced by getTabForm(), and showTab().

SettingsTabHandler._isTabTemplate ( )

Check if the tab use a template or not.

Returns:: boolean

Definition at line 204 of file SettingsTabHandler.inc.php.

References getCurrentTab(), and getPageTabs().

Referenced by showTab().

SettingsTabHandler._isValidTab ( )

Check if the current tab value exists in pageTabsAndForms array.

Returns:: boolean

Definition at line 191 of file SettingsTabHandler.inc.php.

References getCurrentTab(), and getPageTabs().

Referenced by saveFormData(), and showTab().

SettingsTabHandler.authorize	(	&$	request,
		$	args,
		$	roleAssignments
	)

See also:: PKPHandler.authorize()

Definition at line 89 of file SettingsTabHandler.inc.php.

SettingsTabHandler.getCurrentTab ( )

Get the current tab name.

Returns:: string

Definition at line 48 of file SettingsTabHandler.inc.php.

Referenced by _getTabTemplate(), _isTabTemplate(), _isValidTab(), and getTabForm().

SettingsTabHandler.getPageTabs ( )

Get an array with current page tabs and its respective forms or templates.

Returns:: array

Definition at line 64 of file SettingsTabHandler.inc.php.

Referenced by _getTabTemplate(), _isTabTemplate(), _isValidTab(), and getTabForm().

SettingsTabHandler.getTabForm ( )

Return an instance of the form based on the current tab.

Returns:: Form

Definition at line 153 of file SettingsTabHandler.inc.php.

References _getFormClassName(), _isManagementHandler(), getCurrentTab(), and getPageTabs().

Referenced by WebsiteSettingsTabHandler.deleteFile(), AdminSettingsTabHandler.deleteFile(), WebsiteSettingsTabHandler.fetchFile(), AdminSettingsTabHandler.fetchFile(), saveFormData(), and showTab().

SettingsTabHandler.initialize ( &$ request )

See also:: PKPHandler.initialize()

Definition at line 82 of file SettingsTabHandler.inc.php.

References setCurrentTab().

SettingsTabHandler.saveFormData	(	$	args,
		&$	request
	)

Handle forms data (save or edit).

Parameters:

$request

Definition at line 126 of file SettingsTabHandler.inc.php.

References _isValidTab(), and getTabForm().

SettingsTabHandler.setCurrentTab ( $ currentTab )

Set the current tab name.

Parameters:

$currentTab

string

Definition at line 56 of file SettingsTabHandler.inc.php.

Referenced by initialize().

SettingsTabHandler.setPageTabs ( $ pageTabs )

Set an array with current page tabs and its respective forms or templates.

Parameters:

array

Definition at line 72 of file SettingsTabHandler.inc.php.

Referenced by AccessSettingsTabHandler.AccessSettingsTabHandler(), AdminSettingsTabHandler.AdminSettingsTabHandler(), DistributionSettingsTabHandler.DistributionSettingsTabHandler(), PressSettingsTabHandler.PressSettingsTabHandler(), PublicationSettingsTabHandler.PublicationSettingsTabHandler(), and WebsiteSettingsTabHandler.WebsiteSettingsTabHandler().

SettingsTabHandler.SettingsTabHandler ( $ role )

Constructor

Parameters:

$role

string The role keys to be used in role assignment.

Definition at line 32 of file SettingsTabHandler.inc.php.

Referenced by AdminSettingsTabHandler.AdminSettingsTabHandler(), and ManagerSettingsTabHandler.ManagerSettingsTabHandler().

SettingsTabHandler.showTab	(	$	args,
		&$	request
	)

Show a tab.

Definition at line 101 of file SettingsTabHandler.inc.php.

References _getTabTemplate(), _isManagementHandler(), _isTabTemplate(), _isValidTab(), and getTabForm().

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

controllers/tab/settings/SettingsTabHandler.inc.php