Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Handler Class Reference
Inheritance diagram for Handler:
PKPHandler AboutContextHandler AboutSiteHandler AdminHandler CarouselHandler CatalogBookHandler CatalogHandler ContextSettingsWizardHandler DashboardHandler FileApiHandler FileManagementHandler IndexHandler InformationCenterHandler InformationHandler ManageCatalogHandler ManagementHandler ManagerHandler NotificationHandler OAIHandler PageHandler PaymentHandler PKPAnnouncementHandler PKPAuthorDashboardHandler PKPInstallHandler PKPLoginHandler PKPManageFileApiHandler PKPSubmissionHandler PKPUserHandler PublicationEntryHandler PublicationEntryTabHandler PublicationFormatHandler ReportGeneratorHandler SelectMonographHandler SettingsTabHandler SignoffInformationCenterHandler SubmissionMetadataHandler TranslatorHandler

Public Member Functions

 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

Base request handler application class.

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

Member Function Documentation

Handler::getSiteRedirectContext (   $request)

Return the press that is configured in site redirect setting.

Parameters
$requestRequest
Returns
mixed Either Press or null

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

References DAORegistry\getDAO().

Referenced by getTargetContext().

Handler::getTargetContext (   $request,
  $bestGuess = true 
)

Returns a "best-guess" press, based in the request data, if a request needs to have one in its context but may be in a site-level context as specified in the URL.

Parameters
$requestRequest
$bestGuesstrue iff the function should make a best guess if no single context is appropriate
Returns
mixed Either a Press or null if none could be determined.

Definition at line 58 of file Handler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getFirstUserContext(), and getSiteRedirectContext().

Referenced by LoginHandler\_redirectAfterLogin(), and IndexHandler\index().

Handler::getWorkingContexts (   $request)

Get the iterator of working contexts.

Parameters
$requestPKPRequest
Returns
ItemIterator

Definition at line 33 of file Handler.inc.php.

References DAORegistry\getDAO(), and Config\getVar().

Referenced by PageHandler\header(), AdminHandler\index(), and WebsiteSettingsTabHandler\showTab().

Handler::Handler ( )

Constructor

Definition at line 24 of file Handler.inc.php.


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