Open Journal Systems  3.3.0
StaticPagesHandler Class Reference
Inheritance diagram for StaticPagesHandler:
Handler PKPHandler

Public Member Functions

 index ($args, $request)
 
 view ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Static Public Member Functions

static setPage ($staticPage)
 
static setPlugin ($plugin)
 
- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

Static Public Attributes

static $plugin
 
static $staticPage
 

Additional Inherited Members

- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Find static page content and display it when requested.

Definition at line 17 of file StaticPagesHandler.inc.php.

Member Function Documentation

◆ index()

StaticPagesHandler::index (   $args,
  $request 
)

Handle index request (redirect to "view")

Parameters
$argsarray Arguments array.
$requestPKPRequest Request object.

Reimplemented from PKPHandler.

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

◆ setPage()

static StaticPagesHandler::setPage (   $staticPage)
static

Set a static page to view.

Parameters
$staticPageStaticPage

Definition at line 43 of file StaticPagesHandler.inc.php.

References $staticPage.

Referenced by StaticPagesPlugin\callbackHandleContent().

◆ setPlugin()

static StaticPagesHandler::setPlugin (   $plugin)
static

Provide the static pages plugin to the handler.

Parameters
$pluginStaticPagesPlugin

Definition at line 35 of file StaticPagesHandler.inc.php.

References $plugin.

Referenced by StaticPagesPlugin\callbackHandleContent().

◆ view()

StaticPagesHandler::view (   $args,
  $request 
)

Handle view page request (redirect to "view")

Parameters
$argsarray Arguments array.
$requestPKPRequest Request object.

Definition at line 61 of file StaticPagesHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), PKPHandler\getId(), PKPTemplateManager\getManager(), AppLocale\requireComponents(), and PKPHandler\setupTemplate().

Field Documentation

◆ $plugin

StaticPagesPlugin StaticPagesHandler::$plugin
static

The static pages plugin

Definition at line 22 of file StaticPagesHandler.inc.php.

Referenced by setPlugin().

◆ $staticPage

StaticPage StaticPagesHandler::$staticPage
static

The static page to view

Definition at line 28 of file StaticPagesHandler.inc.php.

Referenced by setPage().


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