Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SettingsTabHandler Class Reference
Inheritance diagram for SettingsTabHandler:
Handler PKPHandler AdminSettingsTabHandler ManagerSettingsTabHandler AccessSettingsTabHandler DistributionSettingsTabHandler PressSettingsTabHandler PublicationSettingsTabHandler WebsiteSettingsTabHandler

Public Member Functions

 _getFormClassName ($classPath)
 
 _getTabTemplate ()
 
 _isManagementHandler ()
 
 _isTabTemplate ()
 
 _isValidTab ()
 
 getCurrentTab ()
 
 getPageTabs ()
 
 getTabForm ()
 
 initialize ($request)
 
 saveFormData ($args, $request)
 
 setCurrentTab ($currentTab)
 
 setPageTabs ($pageTabs)
 
 SettingsTabHandler ($role)
 
 showTab ($args, $request)
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

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

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

Member Function Documentation

SettingsTabHandler::_getFormClassName (   $classPath)

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

Parameters
$classPathstring
Returns
string

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

SettingsTabHandler::_getTabTemplate ( )

Return the tab template file

Returns
string

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

References getCurrentTab(), and getPageTabs().

SettingsTabHandler::_isManagementHandler ( )

Check if this handles management settings.

Returns
boolean

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

SettingsTabHandler::_isTabTemplate ( )

Check if the tab use a template or not.

Returns
boolean

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

Referenced by initialize().

SettingsTabHandler::_isValidTab ( )

Check if the current tab value exists in pageTabsAndForms array.

Returns
boolean

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

Referenced by initialize().

SettingsTabHandler::getCurrentTab ( )

Get the current tab name.

Returns
string

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

Referenced by _getTabTemplate().

SettingsTabHandler::getPageTabs ( )

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

Returns
array

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

Referenced by _getTabTemplate().

SettingsTabHandler::getTabForm ( )

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

Returns
Form

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

Referenced by WebsiteSettingsTabHandler\deleteFile(), AdminSettingsTabHandler\deleteFile(), WebsiteSettingsTabHandler\fetchFile(), and AdminSettingsTabHandler\fetchFile().

SettingsTabHandler::initialize (   $request)
SettingsTabHandler::saveFormData (   $args,
  $request 
)

Handle forms data (save or edit).

Parameters
$requestRequest

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

SettingsTabHandler::setCurrentTab (   $currentTab)

Set the current tab name.

Parameters
$currentTabstring

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

Referenced by setPageTabs().

SettingsTabHandler::SettingsTabHandler (   $role)

Constructor

Parameters
$rolestring The role keys to be used in role assignment.

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

SettingsTabHandler::showTab (   $args,
  $request 
)

Show a tab.

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


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