Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
PKPPageRouter Class Reference
Inheritance diagram for PKPPageRouter:
PKPRouter PageRouter

Public Member Functions

 _getRequestedUrlParts ($callback, &$request)
 
 getCacheablePages ()
 
 getCacheFilename (&$request)
 
 getInstallationPages ()
 
 getRequestedArgs (&$request)
 
 getRequestedOp (&$request)
 
 getRequestedPage (&$request)
 
 handleAuthorizationFailure ($request, $authorizationMessage)
 
 isCacheable (&$request, $testOnly=false)
 
 route (&$request)
 
 url (&$request, $newContext=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 
- Public Member Functions inherited from PKPRouter
 _authorizeInitializeAndCallRequest (&$serviceEndpoint, &$request, &$args, $validate=true)
 
 _contextLevelToContextName ($contextLevel)
 
 _contextNameToContextLevel ($contextName)
 
 _urlCanonicalizeNewContext ($newContext)
 
 _urlFromParts ($baseUrl, $pathInfoArray=array(), $queryParametersArray=array(), $anchor= '', $escape=false)
 
 _urlGetAdditionalParameters (&$request, $params=null, $escape=true)
 
 _urlGetBaseAndContext (&$request, $newContext=array())
 
getApplication ()
 
 getCacheFilename (&$request)
 
getContext (&$request, $requestedContextLevel=1)
 
getContextByName (&$request, $requestedContextName)
 
getDispatcher ()
 
 getIndexUrl (&$request)
 
 getRequestedContextPath (&$request, $requestedContextLevel=1)
 
 getRequestedContextPaths (&$request)
 
 handleAuthorizationFailure ($request, $authorizationMessage)
 
 isCacheable (&$request)
 
 route (&$request)
 
 setApplication (&$application)
 
 setDispatcher (&$dispatcher)
 
 supports (&$request)
 
 url (&$request, $newContext=null, $handler=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 

Detailed Description

Class mapping an HTTP request to a handler or context.

Definition at line 21 of file PKPPageRouter.inc.php.

Member Function Documentation

PKPPageRouter::_getRequestedUrlParts (   $callback,
$request 
)

Retrieve part of the current requested url using the passed callback method.

Parameters
$callbackarray Core method to retrieve page, operation or arguments from url.
$requestPKPRequest
Returns
array|string|null

Definition at line 391 of file PKPPageRouter.inc.php.

Referenced by getRequestedArgs(), getRequestedOp(), and getRequestedPage().

PKPPageRouter::getCacheablePages ( )

get the cacheable pages

Returns
array

Definition at line 51 of file PKPPageRouter.inc.php.

Referenced by isCacheable().

PKPPageRouter::getCacheFilename ( $request)
PKPPageRouter::getInstallationPages ( )

get the installation pages

Returns
array

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

Referenced by route().

PKPPageRouter::getRequestedArgs ( $request)

Get the arguments requested in the URL.

Parameters
$requestPKPRequest the request to be routed
Returns
array

Definition at line 112 of file PKPPageRouter.inc.php.

References _getRequestedUrlParts().

Referenced by route().

PKPPageRouter::getRequestedOp ( $request)

Get the operation requested in the URL (assumed to exist in the requested page handler).

Parameters
$requestPKPRequest the request to be routed
Returns
string

Definition at line 100 of file PKPPageRouter.inc.php.

References _getRequestedUrlParts().

Referenced by route(), and url().

PKPPageRouter::getRequestedPage ( $request)

Get the page requested in the URL.

Parameters
$requestPKPRequest the request to be routed
Returns
String the page path (under the "pages" directory)

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

References _getRequestedUrlParts().

Referenced by isCacheable(), route(), and url().

PKPPageRouter::handleAuthorizationFailure (   $request,
  $authorizationMessage 
)
PKPPageRouter::isCacheable ( $request,
  $testOnly = false 
)

Determine whether or not the request is cacheable.

Parameters
$requestPKPRequest
$testOnlyboolean required for unit test to bypass session check.
Returns
boolean

Definition at line 63 of file PKPPageRouter.inc.php.

References PKPRouter\getApplication(), getCacheablePages(), getRequestedPage(), Config\getVar(), and Validation\isLoggedIn().

PKPPageRouter::url ( $request,
  $newContext = null,
  $page = null,
  $op = null,
  $path = null,
  $params = null,
  $anchor = null,
  $escape = false 
)

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