NullHTTPRequest
class NullHTTPRequest extends HTTPRequest (View source)
Implements the "Null Object" pattern for a missing http request.
Set on controllers on construction time, typically overwritten by {@link Controller->handleRequest()} and {@link Controller->handleAction()} later on.
Methods
Construct a HTTPRequest from a URL relative to the site root.
Returns all combined HTTP GET and POST parameters passed into this request. If a parameter with the same name exists in both arrays, the POST value is returned.
Returns a possible file extension found in parsing the URL as denoted by a "."-character near the end of the URL.
Checks if the {@link HTTPRequest->getExtension()} on this request matches one of the more common media types embedded into a webpage - e.g. css, png.
Add a HTTP header to the response, replacing any header of the same name.
Remove an existing HTTP header by its name, e.g. "Content-Type".
Returns the URL used to generate the page
Returns true if this request an ajax request, based on custom HTTP ajax added by common JavaScript libraries, or based on an explicit "ajax" request parameter.
Enables the existence of a key-value pair in the request to be checked using array syntax, so isset($request['title']) will check for $_POST['title'] and $_GET['title']
Access a request variable using array syntax. eg: $request['title'] instead of $request->postVar('title')
Construct an HTTPResponse that will deliver a file to the client.
Matches a URL pattern The pattern can contain a number of segments, separated by / (and an extension indicated by a .)
Shift all the parameter values down a key space, and return the shifted value.
Finds a named URL parameter (denoted by "$"-prefix in $url_handlers) from the full URL, or a parameter specified in the route table
Returns the unparsed part of the original URL separated by commas. This is used by {@link RequestHandler->handleRequest()} to determine if further URL processing is necessary.
Returns true if this is a URL that will match without shifting off any of the URL.
Shift one or more parts off the beginning of the URL.
Returns all mimetypes from the HTTP "Accept" header as an array.
Gets the "real" HTTP method for a request.
Details
__construct()
Construct a HTTPRequest from a URL relative to the site root.
HTTPRequest
setUrl(string $url)
Allow the setting of a URL
This is here so that RootURLController can change the URL of the request without us loosing all the other info attached (like headers)
bool
isGET()
bool
isPOST()
bool
isPUT()
bool
isDELETE()
bool
isHEAD()
HTTPRequest
setBody(string $body)
null|string
getBody()
array
getVars()
array
postVars()
array
requestVars()
Returns all combined HTTP GET and POST parameters passed into this request. If a parameter with the same name exists in both arrays, the POST value is returned.
mixed
getVar(string $name)
mixed
postVar(string $name)
mixed
requestVar(string $name)
string
getExtension()
Returns a possible file extension found in parsing the URL as denoted by a "."-character near the end of the URL.
Doesn't necessarily have to belong to an existing file, as extensions can be also used for content-type-switching.
bool
isMedia()
Checks if the {@link HTTPRequest->getExtension()} on this request matches one of the more common media types embedded into a webpage - e.g. css, png.
This is useful for things like determining whether to display a fully rendered error page or not. Note that the media file types is not at all comprehensive.
addHeader(string $header, string $value)
Add a HTTP header to the response, replacing any header of the same name.
array
getHeaders()
mixed
getHeader(string $header)
Remove an existing HTTP header
HTTPRequest
removeHeader(string $header)
Remove an existing HTTP header by its name, e.g. "Content-Type".
string
getURL(bool $includeGetVars = false)
Returns the URL used to generate the page
bool
isAjax()
Returns true if this request an ajax request, based on custom HTTP ajax added by common JavaScript libraries, or based on an explicit "ajax" request parameter.
bool
offsetExists(string $offset)
Enables the existence of a key-value pair in the request to be checked using array syntax, so isset($request['title']) will check for $_POST['title'] and $_GET['title']
mixed
offsetGet(string $offset)
Access a request variable using array syntax. eg: $request['title'] instead of $request->postVar('title')
offsetSet($offset, $value)
offsetUnset($offset)
static HTTPResponse
send_file($fileData, $fileName, null $mimeType = null)
Construct an HTTPResponse that will deliver a file to the client.
Caution: Since it requires $fileData to be passed as binary data (no stream support),
it's only advisable to send small files through this method.
This function needs to be called inside the controller’s response, e.g.:
$this->setResponse(HTTPRequest::send_file('the content', 'filename.txt'));
array|bool
match($pattern, bool $shiftOnSuccess = false)
Matches a URL pattern The pattern can contain a number of segments, separated by / (and an extension indicated by a .)
The parts can be either literals, or, if they start with a $ they are interpreted as variables.
- Literals must be provided in order to match
- $Variables are optional
- However, if you put ! at the end of a variable, then it becomes mandatory.
For example:
- admin/crm/list will match admin/crm/$Action/$ID/$OtherID, but it won't match admin/crm/$Action!/$ClassName!
The pattern can optionally start with an HTTP method and a space. For example, "POST $Controller/$Action". This is used to define a rule that only matches on a specific HTTP method.
array
allParams()
string
shiftAllParams()
Shift all the parameter values down a key space, and return the shifted value.
array
latestParams()
string|null
latestParam(string $name)
array
routeParams()
HTTPRequest
setRouteParams($params)
array
params()
string
param(string $name)
Finds a named URL parameter (denoted by "$"-prefix in $url_handlers) from the full URL, or a parameter specified in the route table
string
remaining()
Returns the unparsed part of the original URL separated by commas. This is used by {@link RequestHandler->handleRequest()} to determine if further URL processing is necessary.
bool
isEmptyPattern(string $pattern)
Returns true if this is a URL that will match without shifting off any of the URL.
This is used by the request handler to prevent infinite parsing loops.
string|array
shift(int $count = 1)
Shift one or more parts off the beginning of the URL.
If you specify shifting more than 1 item off, then the items will be returned as an array
bool
allParsed()
Returns true if the URL has been completely parsed.
This will respect parsed but unshifted directory parts.
string
getHost()
string
getIP()
Returns the client IP address which originated this request.
$this
setIP($ip)
Sets the client IP address which originated this request.
Use setIPFromHeaderValue if assigning from header value.
array
getAcceptMimetypes(bool $includeQuality = false)
Returns all mimetypes from the HTTP "Accept" header as an array.
string
httpMethod()
string
getScheme()
Return the URL scheme (e.g. "http" or "https").
Equivalent to PSR-7 getUri()->getScheme()
$this
setScheme(string $scheme)
Set the URL scheme (e.g. "http" or "https").
Equivalent to PSR-7 getUri()->getScheme(),
static string
detect_method(string $origMethod, array $postVars)
Gets the "real" HTTP method for a request.
Used to work around browser limitations of form submissions to GET and POST, by overriding the HTTP method with a POST parameter called "_method" for PUT, DELETE, HEAD. Using GET for the "_method" override is not supported, as GET should never carry out state changes. Alternatively you can use a custom HTTP header 'X-HTTP-Method-Override' to override the original method. The '_method' POST parameter overrules the custom HTTP header.
bool
hasSession()
Determines whether the request has a session