Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Request Class Reference
Inheritance diagram for Request:
PKPRequest PKPRequest

Public Member Functions

getContext ($level=1)
 
getContextByName ($contextName)
 
getPress ()
 
 getRequestedContextPath ($contextLevel=null)
 
 getRequestedPressPath ()
 
 getUserAgent ()
 
 redirectHome ()
 
 url ($pressPath=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 
- Public Member Functions inherited from PKPRequest
_checkThis ()
 
_delegateToRouter ($method)
 
 cleanUserVar (&$var)
 
 encodeBasePathFragment ($fragment)
 
 getBasePath ()
 
 getBaseUrl ()
 
 getCompleteUrl ()
 
getContext ()
 
 getCookieVar ($key)
 
getDispatcher ()
 
 getIfModifiedSince ()
 
 getIndexUrl ()
 
 getProtocol ()
 
 getQueryArray ()
 
 getQueryString ()
 
 getRemoteAddr ()
 
 getRemoteDomain ()
 
 getRequestedArgs ()
 
 getRequestedContextPath ($contextLevel=null)
 
 getRequestedOp ()
 
 getRequestedPage ()
 
 getRequestMethod ()
 
 getRequestPath ()
 
 getRequestUrl ()
 
getRouter ()
 
 getServerHost ($default= 'localhost')
 
getSession ()
 
getSite ()
 
getUser ()
 
 getUserAgent ()
 
 getUserDateVar ($prefix, $defaultDay=null, $defaultMonth=null, $defaultYear=null, $defaultHour=0, $defaultMinute=0, $defaultSecond=0)
 
 getUserVar ($key)
 
getUserVars ()
 
 isBot ()
 
 isGet ()
 
 isPathInfoEnabled ()
 
 isPost ()
 
 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)
 
 url ($context=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 

Additional Inherited Members

- Public Attributes inherited from PKPRequest
 $_basePath
 
 $_baseUrl
 
 $_dispatcher = null
 
 $_isBot
 
 $_isPathInfoEnabled
 
 $_isRestfulUrlsEnabled
 
 $_protocol
 
 $_requestPath
 
 $_requestVars = null
 
 $_router = null
 
 $_serverHost
 
 $_userAgent
 

Detailed Description

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

Mock implementation of the Request class.

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

Member Function Documentation

& Request::getContext (   $level = 1)

Deprecated

See Also
PKPPageRouter::getContext()

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

References PKPRequest\_checkThis().

& Request::getContextByName (   $contextName)

Deprecated

See Also
PKPPageRouter::getContextByName()

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

References PKPRequest\_checkThis().

& Request::getPress ( )

Deprecated

See Also
PKPPageRouter::getContext()

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

References PKPRequest\_checkThis().

Request::getRequestedContextPath (   $contextLevel = null)

Deprecated

See Also
PKPPageRouter::getRequestedContextPath()

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

References PKPRequest\_checkThis().

Request::getRequestedPressPath ( )

Deprecated

See Also
PKPPageRouter::getRequestedContextPath()

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

References PKPRequest\_checkThis(), and HookRegistry\call().

Request::getUserAgent ( )
See Also
PKPRequest::getUserAgent()

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

Request::redirectHome ( )

Deprecated

See Also
PageRouter::redirectHome()

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

References PKPRequest\_checkThis().

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

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