Open Journal Systems  3.3.0
Request Class Reference
Inheritance diagram for Request:
PKPRequest

Public Member Functions

getContext ($level=1)
 
getContextByName ($contextName)
 
getJournal ()
 
 getRequestedContextPath ($contextLevel=null)
 
 getRequestedJournalPath ()
 
 isPost ()
 
 redirectHome ()
 
 setRequestMethod ($requestMethod)
 
 url ($journalPath=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 
- Public Member Functions inherited from PKPRequest
_delegateToRouter ($method)
 
 checkCSRF ()
 
 encodeBasePathFragment ($fragment)
 
 getBasePath ()
 
 getBaseUrl ($allowProtocolRelative=false)
 
 getCompleteUrl ()
 
getContext ()
 
 getCookieVar ($key)
 
getDispatcher ()
 
 getIfModifiedSince ()
 
 getIndexUrl ()
 
 getProtocol ()
 
 getQueryArray ()
 
 getQueryString ()
 
 getRemoteAddr ()
 
 getRemoteDomain ()
 
 getRequestedArgs ()
 
 getRequestedOp ()
 
 getRequestedPage ()
 
 getRequestMethod ()
 
 getRequestPath ()
 
 getRequestUrl ()
 
getRouter ()
 
 getServerHost ($default=null, $includePort=true)
 
getSession ()
 
getSite ()
 
getUser ()
 
 getUserAgent ()
 
 getUserDateVar ($prefix, $defaultDay=null, $defaultMonth=null, $defaultYear=null, $defaultHour=0, $defaultMinute=0, $defaultSecond=0)
 
 getUserVar ($key)
 
getUserVars ()
 
 isBot ()
 
 isGet ()
 
 isPathInfoEnabled ()
 
 isRestfulUrlsEnabled ()
 
 redirect ($context=null, $page=null, $op=null, $path=null, $params=null, $anchor=null)
 
 redirectNonSSL ()
 
 redirectSSL ()
 
 redirectUrl ($url)
 
 redirectUrlJson ($url)
 
 setCookieVar ($key, $value, $expire=0)
 
 setDispatcher ($dispatcher)
 
 setRouter ($router)
 

Additional Inherited Members

- Data Fields inherited from PKPRequest
 $_basePath
 
 $_dispatcher = null
 
 $_isBot
 
 $_isPathInfoEnabled
 
 $_isRestfulUrlsEnabled
 
 $_protocol
 
 $_requestPath
 
 $_requestVars = null
 
 $_router = null
 
 $_serverHost
 
 $_userAgent
 

Detailed Description

Mock implementation of the Request class.

Class providing operations associated with HTTP requests.
* Requests are assumed to be in the format http://host.tld/index.php/<journal_id>/<page_name>/<operation_name>/<arguments...>
* <journal_id> is assumed to be "index" for top-level site requests. 

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

Member Function Documentation

◆ getContext()

& Request::getContext (   $level = 1)

Deprecated

See also
PKPPageRouter::getContext()

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

References PKPRequest\_delegateToRouter().

◆ getContextByName()

& Request::getContextByName (   $contextName)

Deprecated

See also
PKPPageRouter::getContextByName()

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

References PKPRequest\_delegateToRouter().

◆ getJournal()

& Request::getJournal ( )
See also
PKPPageRouter::getContext()

Definition at line 40 of file Request.inc.php.

References PKPRequest\_delegateToRouter().

◆ getRequestedContextPath()

Request::getRequestedContextPath (   $contextLevel = null)

Deprecated

See also
PKPPageRouter::getRequestedContextPath()

Reimplemented from PKPRequest.

Definition at line 49 of file Request.inc.php.

References PKPRequest\_delegateToRouter().

◆ getRequestedJournalPath()

Request::getRequestedJournalPath ( )

◆ isPost()

Request::isPost ( )

Determine whether the request is a POST request

Returns
boolean

Reimplemented from PKPRequest.

Definition at line 26 of file MockRequest.inc.php.

◆ redirectHome()

Request::redirectHome ( )

Deprecated

See also
PageRouter::redirectHome()

Definition at line 91 of file Request.inc.php.

References PKPRequest\_delegateToRouter().

◆ setRequestMethod()

Request::setRequestMethod (   $requestMethod)

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

◆ url()

Request::url (   $journalPath = null,
  $page = null,
  $op = null,
  $path = null,
  $params = null,
  $anchor = null,
  $escape = false 
)

Deprecated

See also
PKPPageRouter::url()

Reimplemented from PKPRequest.

Definition at line 81 of file Request.inc.php.

References $op, and PKPRequest\_delegateToRouter().


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