MINOR Documentation for HTTPRequest and RequestHandlingData

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@63657 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2008-10-05 22:35:14 +00:00
parent 1bb708377d
commit 78469b86e6
2 changed files with 18 additions and 2 deletions

View File

@ -10,11 +10,26 @@
* @subpackage control
*/
class Controller extends RequestHandlingData {
/**
* An array of arguments extracted from the URL
* @var array $urlParams An array of arguments extracted from the URL
*/
protected $urlParams;
/**
* @var array $requestParams Contains all GET and POST parameters
* passed to the current {@link HTTPRequest}.
* @uses HTTPRequest->requestVars()
*/
protected $requestParams;
/**
* @var string $action The URL part matched on the current controller as
* determined by the "$Action" part of the {@link $url_handlers} definition.
* Should correlate to a public method on this controller.
* Used in {@link render()} and {@link getViewer()} to determine
* action-specific templates.
*/
protected $action;
/**

View File

@ -17,9 +17,10 @@
class HTTPRequest extends Object implements ArrayAccess {
/**
* The non-extension parts of the URL, separated by "/".
* The non-extension parts of the passed URL as an array, originally exploded by the "/" separator.
* All elements of the URL are loaded in here,
* and subsequently popped out of the array by {@link shift()}.
* Only use this structure for internal request handling purposes.
*/
protected $dirParts;