mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 12:05:37 +00:00
updating comments for HTTPRequest - immutability
SS_HTTPRequest can be read like an array, e.g. echo $request['a'], but cannot be written like an array, e.g. $request['a'] = 5; Added comment to caution people. See line 375: ================================================================== /** * @ignore */ public function offsetSet($offset, $value) {} /** * @ignore */ public function offsetUnset($offset) {} ================================================================== Might be good to write something about how you are supposed to modify a request, or what you are supposed to do instead (a redirect?).
This commit is contained in:
parent
1cc366fe23
commit
7f39fb50a6
@ -4,6 +4,9 @@
|
|||||||
* Represents a HTTP-request, including a URL that is tokenised for parsing, and a request method
|
* Represents a HTTP-request, including a URL that is tokenised for parsing, and a request method
|
||||||
* (GET/POST/PUT/DELETE). This is used by {@link RequestHandler} objects to decide what to do.
|
* (GET/POST/PUT/DELETE). This is used by {@link RequestHandler} objects to decide what to do.
|
||||||
*
|
*
|
||||||
|
* Caution: objects of this class are immutable, e.g. echo $request['a']; works as expected,
|
||||||
|
* but $request['a'] = '1'; has no effect.
|
||||||
|
*
|
||||||
* The intention is that a single SS_HTTPRequest object can be passed from one object to another, each object calling
|
* The intention is that a single SS_HTTPRequest object can be passed from one object to another, each object calling
|
||||||
* match() to get the information that they need out of the URL. This is generally handled by
|
* match() to get the information that they need out of the URL. This is generally handled by
|
||||||
* {@link RequestHandler::handleRequest()}.
|
* {@link RequestHandler::handleRequest()}.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user