Manual:WebRequest.php

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎中文

Details[edit]

The WebRequest class which encapsulates getting at data passed in the URL or via a POSTed form, handling remove of "magic quotes" slashes, stripping illegal input characters and normalizing Unicode sequences.

You can access the standard WebRequest through RequestContext.phpManual:RequestContext.php.

You should not create additional instances of this class.

Instead create a DerivativeRequest or use FauxRequest if there is no user request context.

Functions[edit]

  • getVal: get a scalar or null if the parameter was not passed
  • getInt: same as before, but the value returned is an integer
  • getBool: same as getVal, but returns a boolean value
  • getArray: get an array or null if the parameter was not passed. If the parameter is a scalar, it will return an array with a single element.
  • getCheck: return a boolean whether the parameter was passed, this is useful for checkboxes.
  • getCookie: get a cookie from the $_COOKIE jar
  • wasPosted: returns a bool whether the request was posted

... many more, this is a partial list.

WebRequestUpload[edit]

WebRequestUpload is an object to access the $_FILES array. It should only be called by WebRequest. A WebRequestUpload object is generated by WebRequest::getUpload().

Functions[edit]

  • __construct( $request, $key )

FauxRequest[edit]

FauxRequest is a class extending WebRequest. Its purpose is to emulate a request for testing or prototyping. FauxRequest should be avoided in production code.

Also see API:Calling internallyAPI:Calling internally for an example.

See also[edit]