mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-08 10:41:25 +02:00
Merge pull request #814 from Zauberfisch/master
HTTPRequest and HTTPResponse now return $this on all setters
This commit is contained in:
commit
cc702df8bb
@ -122,37 +122,67 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
$this->body = $body;
|
$this->body = $body;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function isGET() {
|
public function isGET() {
|
||||||
return $this->httpMethod == 'GET';
|
return $this->httpMethod == 'GET';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function isPOST() {
|
public function isPOST() {
|
||||||
return $this->httpMethod == 'POST';
|
return $this->httpMethod == 'POST';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function isPUT() {
|
public function isPUT() {
|
||||||
return $this->httpMethod == 'PUT';
|
return $this->httpMethod == 'PUT';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function isDELETE() {
|
public function isDELETE() {
|
||||||
return $this->httpMethod == 'DELETE';
|
return $this->httpMethod == 'DELETE';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
public function isHEAD() {
|
public function isHEAD() {
|
||||||
return $this->httpMethod == 'HEAD';
|
return $this->httpMethod == 'HEAD';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $body
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
|
*/
|
||||||
public function setBody($body) {
|
public function setBody($body) {
|
||||||
$this->body = $body;
|
$this->body = $body;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
public function getBody() {
|
public function getBody() {
|
||||||
return $this->body;
|
return $this->body;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function getVars() {
|
public function getVars() {
|
||||||
return $this->getVars;
|
return $this->getVars;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function postVars() {
|
public function postVars() {
|
||||||
return $this->postVars;
|
return $this->postVars;
|
||||||
}
|
}
|
||||||
@ -168,14 +198,26 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
return ArrayLib::array_merge_recursive($this->getVars, $this->postVars);
|
return ArrayLib::array_merge_recursive($this->getVars, $this->postVars);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
public function getVar($name) {
|
public function getVar($name) {
|
||||||
if(isset($this->getVars[$name])) return $this->getVars[$name];
|
if(isset($this->getVars[$name])) return $this->getVars[$name];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
public function postVar($name) {
|
public function postVar($name) {
|
||||||
if(isset($this->postVars[$name])) return $this->postVars[$name];
|
if(isset($this->postVars[$name])) return $this->postVars[$name];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
public function requestVar($name) {
|
public function requestVar($name) {
|
||||||
if(isset($this->postVars[$name])) return $this->postVars[$name];
|
if(isset($this->postVars[$name])) return $this->postVars[$name];
|
||||||
if(isset($this->getVars[$name])) return $this->getVars[$name];
|
if(isset($this->getVars[$name])) return $this->getVars[$name];
|
||||||
@ -227,6 +269,7 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
* Remove an existing HTTP header
|
* Remove an existing HTTP header
|
||||||
*
|
*
|
||||||
* @param string $header
|
* @param string $header
|
||||||
|
* @return mixed
|
||||||
*/
|
*/
|
||||||
public function getHeader($header) {
|
public function getHeader($header) {
|
||||||
return (isset($this->headers[$header])) ? $this->headers[$header] : null;
|
return (isset($this->headers[$header])) ? $this->headers[$header] : null;
|
||||||
@ -237,16 +280,17 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
* e.g. "Content-Type".
|
* e.g. "Content-Type".
|
||||||
*
|
*
|
||||||
* @param string $header
|
* @param string $header
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
*/
|
*/
|
||||||
public function removeHeader($header) {
|
public function removeHeader($header) {
|
||||||
if(isset($this->headers[$header])) unset($this->headers[$header]);
|
if(isset($this->headers[$header])) unset($this->headers[$header]);
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the URL used to generate the page
|
* Returns the URL used to generate the page
|
||||||
*
|
*
|
||||||
* @param bool $includeGetVars whether or not to include the get parameters\
|
* @param bool $includeGetVars whether or not to include the get parameters\
|
||||||
*
|
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getURL($includeGetVars = false) {
|
public function getURL($includeGetVars = false) {
|
||||||
@ -318,6 +362,12 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Construct an SS_HTTPResponse that will deliver a file to the client
|
* Construct an SS_HTTPResponse that will deliver a file to the client
|
||||||
|
*
|
||||||
|
* @static
|
||||||
|
* @param $fileData
|
||||||
|
* @param $fileName
|
||||||
|
* @param null $mimeType
|
||||||
|
* @return SS_HTTPResponse
|
||||||
*/
|
*/
|
||||||
public static function send_file($fileData, $fileName, $mimeType = null) {
|
public static function send_file($fileData, $fileName, $mimeType = null) {
|
||||||
if(!$mimeType) {
|
if(!$mimeType) {
|
||||||
@ -350,6 +400,10 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
*
|
*
|
||||||
* The pattern can optionally start with an HTTP method and a space. For example, "POST $Controller/$Action".
|
* 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.
|
* This is used to define a rule that only matches on a specific HTTP method.
|
||||||
|
*
|
||||||
|
* @param $pattern
|
||||||
|
* @param bool $shiftOnSuccess
|
||||||
|
* @return array|bool
|
||||||
*/
|
*/
|
||||||
public function match($pattern, $shiftOnSuccess = false) {
|
public function match($pattern, $shiftOnSuccess = false) {
|
||||||
// Check if a specific method is required
|
// Check if a specific method is required
|
||||||
@ -432,6 +486,9 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
return $arguments;
|
return $arguments;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function allParams() {
|
public function allParams() {
|
||||||
return $this->allParams;
|
return $this->allParams;
|
||||||
}
|
}
|
||||||
@ -458,25 +515,42 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
return $value;
|
return $value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function latestParams() {
|
public function latestParams() {
|
||||||
return $this->latestParams;
|
return $this->latestParams;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
public function latestParam($name) {
|
public function latestParam($name) {
|
||||||
if(isset($this->latestParams[$name])) return $this->latestParams[$name];
|
if(isset($this->latestParams[$name])) return $this->latestParams[$name];
|
||||||
else return null;
|
else return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
public function routeParams() {
|
public function routeParams() {
|
||||||
return $this->routeParams;
|
return $this->routeParams;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $params
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
|
*/
|
||||||
public function setRouteParams($params) {
|
public function setRouteParams($params) {
|
||||||
$this->routeParams = $params;
|
$this->routeParams = $params;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function params()
|
/**
|
||||||
{
|
* @return array
|
||||||
|
*/
|
||||||
|
public function params() {
|
||||||
return array_merge($this->allParams, $this->routeParams);
|
return array_merge($this->allParams, $this->routeParams);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -507,6 +581,9 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
/**
|
/**
|
||||||
* Returns true if this is a URL that will match without shifting off any of the URL.
|
* 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.
|
* This is used by the request handler to prevent infinite parsing loops.
|
||||||
|
*
|
||||||
|
* @param $pattern
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function isEmptyPattern($pattern) {
|
public function isEmptyPattern($pattern) {
|
||||||
if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {
|
if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {
|
||||||
@ -521,7 +598,6 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
* If you specify shifting more than 1 item off, then the items will be returned as an array
|
* If you specify shifting more than 1 item off, then the items will be returned as an array
|
||||||
*
|
*
|
||||||
* @param int $count Shift Count
|
* @param int $count Shift Count
|
||||||
*
|
|
||||||
* @return String|Array
|
* @return String|Array
|
||||||
*/
|
*/
|
||||||
public function shift($count = 1) {
|
public function shift($count = 1) {
|
||||||
@ -543,6 +619,8 @@ class SS_HTTPRequest implements ArrayAccess {
|
|||||||
/**
|
/**
|
||||||
* Returns true if the URL has been completely parsed.
|
* Returns true if the URL has been completely parsed.
|
||||||
* This will respect parsed but unshifted directory parts.
|
* This will respect parsed but unshifted directory parts.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function allParsed() {
|
public function allParsed() {
|
||||||
return sizeof($this->dirParts) <= $this->unshiftedButParsedParts;
|
return sizeof($this->dirParts) <= $this->unshiftedButParsedParts;
|
||||||
|
@ -108,6 +108,7 @@ class SS_HTTPResponse {
|
|||||||
* No newlines are allowed in the description.
|
* No newlines are allowed in the description.
|
||||||
* If omitted, will default to the standard HTTP description
|
* If omitted, will default to the standard HTTP description
|
||||||
* for the given $code value (see {@link $status_codes}).
|
* for the given $code value (see {@link $status_codes}).
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
*/
|
*/
|
||||||
public function setStatusCode($code, $description = null) {
|
public function setStatusCode($code, $description = null) {
|
||||||
if(isset(self::$status_codes[$code])) $this->statusCode = $code;
|
if(isset(self::$status_codes[$code])) $this->statusCode = $code;
|
||||||
@ -115,6 +116,7 @@ class SS_HTTPResponse {
|
|||||||
|
|
||||||
if($description) $this->statusDescription = $description;
|
if($description) $this->statusDescription = $description;
|
||||||
else $this->statusDescription = self::$status_codes[$code];
|
else $this->statusDescription = self::$status_codes[$code];
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -122,9 +124,11 @@ class SS_HTTPResponse {
|
|||||||
* Caution: Will be overwritten by {@link setStatusCode()}.
|
* Caution: Will be overwritten by {@link setStatusCode()}.
|
||||||
*
|
*
|
||||||
* @param String $description
|
* @param String $description
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
*/
|
*/
|
||||||
public function setStatusDescription($description) {
|
public function setStatusDescription($description) {
|
||||||
$this->statusDescription = $description;
|
$this->statusDescription = $description;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -143,18 +147,28 @@ class SS_HTTPResponse {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this HTTP response is in error
|
* Returns true if this HTTP response is in error
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function isError() {
|
public function isError() {
|
||||||
return $this->statusCode && ($this->statusCode < 200 || $this->statusCode > 399);
|
return $this->statusCode && ($this->statusCode < 200 || $this->statusCode > 399);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $body
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
|
*/
|
||||||
public function setBody($body) {
|
public function setBody($body) {
|
||||||
$this->body = $body;
|
$this->body = $body;
|
||||||
|
|
||||||
// Set content-length in bytes. Use mbstring to avoid problems with mb_internal_encoding() and mbstring.func_overload
|
// Set content-length in bytes. Use mbstring to avoid problems with mb_internal_encoding() and mbstring.func_overload
|
||||||
$this->headers['Content-Length'] = mb_strlen($this->body,'8bit');
|
$this->headers['Content-Length'] = mb_strlen($this->body,'8bit');
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
public function getBody() {
|
public function getBody() {
|
||||||
return $this->body;
|
return $this->body;
|
||||||
}
|
}
|
||||||
@ -164,23 +178,23 @@ class SS_HTTPResponse {
|
|||||||
*
|
*
|
||||||
* @param string $header Example: "Content-Type"
|
* @param string $header Example: "Content-Type"
|
||||||
* @param string $value Example: "text/xml"
|
* @param string $value Example: "text/xml"
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
*/
|
*/
|
||||||
public function addHeader($header, $value) {
|
public function addHeader($header, $value) {
|
||||||
$this->headers[$header] = $value;
|
$this->headers[$header] = $value;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the HTTP header of the given name.
|
* Return the HTTP header of the given name.
|
||||||
*
|
*
|
||||||
* @param string $header
|
* @param string $header
|
||||||
* @returns string
|
* @returns null|string
|
||||||
*/
|
*/
|
||||||
public function getHeader($header) {
|
public function getHeader($header) {
|
||||||
if(isset($this->headers[$header])) {
|
if(isset($this->headers[$header]))
|
||||||
return $this->headers[$header];
|
return $this->headers[$header];
|
||||||
} else {
|
return null;
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -194,16 +208,24 @@ class SS_HTTPResponse {
|
|||||||
* Remove an existing HTTP header by its name,
|
* Remove an existing HTTP header by its name,
|
||||||
* e.g. "Content-Type".
|
* e.g. "Content-Type".
|
||||||
*
|
*
|
||||||
* @param unknown_type $header
|
* @param string $header
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
*/
|
*/
|
||||||
public function removeHeader($header) {
|
public function removeHeader($header) {
|
||||||
if(isset($this->headers[$header])) unset($this->headers[$header]);
|
if(isset($this->headers[$header])) unset($this->headers[$header]);
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $dest
|
||||||
|
* @param int $code
|
||||||
|
* @return SS_HTTPRequest $this
|
||||||
|
*/
|
||||||
public function redirect($dest, $code=302) {
|
public function redirect($dest, $code=302) {
|
||||||
if(!in_array($code, self::$redirect_codes)) $code = 302;
|
if(!in_array($code, self::$redirect_codes)) $code = 302;
|
||||||
$this->setStatusCode($code);
|
$this->setStatusCode($code);
|
||||||
$this->headers['Location'] = $dest;
|
$this->headers['Location'] = $dest;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -244,6 +266,8 @@ class SS_HTTPResponse {
|
|||||||
/**
|
/**
|
||||||
* Returns true if this response is "finished", that is, no more script execution should be done.
|
* Returns true if this response is "finished", that is, no more script execution should be done.
|
||||||
* Specifically, returns true if a redirect has already been requested
|
* Specifically, returns true if a redirect has already been requested
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function isFinished() {
|
public function isFinished() {
|
||||||
return in_array($this->statusCode, array(301, 302, 401, 403));
|
return in_array($this->statusCode, array(301, 302, 401, 403));
|
||||||
|
Loading…
Reference in New Issue
Block a user