TYPO3
7.6
|
Public Attributes | |
const | PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/' |
Protected Attributes | |
$controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController' | |
$namespacedControllerObjectNamePattern = '@vendor\@extension\@subpackage\Controller\@controllerController' | |
$pluginName = '' | |
$controllerExtensionName = null | |
$controllerVendorName = null | |
$controllerSubpackageKey = null | |
$controllerName = 'Standard' | |
$controllerActionName = 'index' | |
$arguments = array() | |
$internalArguments = array() | |
$format = 'txt' | |
$dispatched = false | |
$originalRequest = null | |
$originalRequestMappingResults = null | |
Represents a generic request.
Definition at line 24 of file extbase/Classes/Mvc/Request.php.
getArgument | ( | $argumentName | ) |
Returns the value of the specified argument
string | $argumentName | Name of the argument |
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException | if such an argument does not exist |
Implements RequestInterface.
Definition at line 475 of file extbase/Classes/Mvc/Request.php.
getArguments | ( | ) |
Returns an array of arguments and their values
Implements RequestInterface.
Definition at line 461 of file extbase/Classes/Mvc/Request.php.
References Request\$arguments.
getControllerActionName | ( | ) |
Returns the name of the action the controller is supposed to execute.
Definition at line 357 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerActionName, and Request\getControllerObjectName().
getControllerExtensionKey | ( | ) |
Returns the extension name of the specified controller.
Definition at line 266 of file extbase/Classes/Mvc/Request.php.
getControllerExtensionName | ( | ) |
Returns the extension name of the specified controller.
Definition at line 255 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerExtensionName.
getControllerName | ( | ) |
Returns the object name of the controller supposed to handle this request, if one was set already (if not, the name of the default controller is returned)
Definition at line 323 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerName.
getControllerObjectName | ( | ) |
Returns the object name of the controller defined by the extension name and controller name
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchControllerException | if the controller does not exist |
Implements RequestInterface.
Definition at line 148 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerActionName().
getControllerSubpackageKey | ( | ) |
Returns the subpackage key of the specified controller. If there is no subpackage key set, the method returns NULL
Definition at line 289 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerSubpackageKey.
getControllerVendorName | ( | ) |
get the VendorName
Definition at line 434 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerVendorName.
getFormat | ( | ) |
Returns the requested representation format
Definition at line 514 of file extbase/Classes/Mvc/Request.php.
References Request\$format.
getInternalArgument | ( | $argumentName | ) |
Returns the value of the specified argument
string | $argumentName | Name of the argument |
Definition at line 578 of file extbase/Classes/Mvc/Request.php.
getInternalArguments | ( | ) |
Get the internal arguments of the request, i.e. every argument starting with two underscores.
Definition at line 566 of file extbase/Classes/Mvc/Request.php.
References Request\$internalArguments.
getOriginalRequest | ( | ) |
Returns the original request. Filled only if a property mapping error occurred.
Definition at line 524 of file extbase/Classes/Mvc/Request.php.
References Request\$originalRequest.
getOriginalRequestMappingResults | ( | ) |
Get the request mapping results for the original request.
Definition at line 544 of file extbase/Classes/Mvc/Request.php.
References Request\$originalRequestMappingResults.
getPluginName | ( | ) |
Returns the plugin key.
Definition at line 229 of file extbase/Classes/Mvc/Request.php.
References Request\$pluginName.
hasArgument | ( | $argumentName | ) |
Checks if an argument of the given name exists (is set)
string | $argumentName | Name of the argument to check |
Implements RequestInterface.
Definition at line 491 of file extbase/Classes/Mvc/Request.php.
isDispatched | ( | ) |
If this request has been dispatched and addressed by the responsible controller and the response is ready to be sent.
The dispatcher will try to dispatch the request again if it has not been addressed yet.
Implements RequestInterface.
Definition at line 135 of file extbase/Classes/Mvc/Request.php.
References Request\$dispatched.
setArgument | ( | $argumentName, | |
$value | |||
) |
Sets the value of the specified argument
string | $argumentName | Name of the argument to set |
mixed | $value | The new value |
Exception\InvalidArgumentNameException |
Implements RequestInterface.
Definition at line 384 of file extbase/Classes/Mvc/Request.php.
References Request\setControllerActionName(), Request\setControllerExtensionName(), Request\setControllerName(), Request\setControllerSubpackageKey(), Request\setControllerVendorName(), and Request\setFormat().
Referenced by Request\setArguments().
setArguments | ( | array | $arguments | ) |
Sets the whole arguments array and therefore replaces any arguments which existed before.
array | $arguments | An array of argument names and their values |
Implements RequestInterface.
Definition at line 447 of file extbase/Classes/Mvc/Request.php.
References Request\setArgument().
setControllerActionName | ( | $actionName | ) |
Sets the name of the action contained in this request.
Note that the action name must start with a lower case letter and is case sensitive.
string | $actionName | Name of the action to execute by the controller |
\TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException | if the action name is not valid |
Definition at line 338 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\setArgument().
setControllerExtensionName | ( | $controllerExtensionName | ) |
Sets the extension name of the controller.
string | $controllerExtensionName | The extension name. |
\TYPO3\CMS\Extbase\Mvc\Exception\InvalidExtensionNameException | if the extension name is not valid |
Definition at line 242 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerExtensionName.
Referenced by Request\setArgument().
setControllerName | ( | $controllerName | ) |
Sets the name of the controller which is supposed to handle the request. Note: This is not the object name of the controller!
string | $controllerName | Name of the controller |
Exception\InvalidControllerNameException |
Definition at line 303 of file extbase/Classes/Mvc/Request.php.
References Request\$controllerName.
Referenced by Request\setArgument().
setControllerObjectName | ( | $controllerObjectName | ) |
Explicitly sets the object name of the controller
string | $controllerObjectName | The fully qualified controller object name |
Definition at line 200 of file extbase/Classes/Mvc/Request.php.
References ClassNamingUtility\explodeObjectControllerName().
Referenced by WidgetRequest\setWidgetContext().
setControllerSubpackageKey | ( | $subpackageKey | ) |
Sets the subpackage key of the controller.
string | $subpackageKey | The subpackage key. |
Definition at line 278 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\setArgument().
setControllerVendorName | ( | $vendorName | ) |
sets the VendorName
string | $vendorName |
Definition at line 424 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\setArgument().
setDispatched | ( | $flag | ) |
Sets the dispatched flag
bool | $flag | If this request has been dispatched |
Implements RequestInterface.
Definition at line 120 of file extbase/Classes/Mvc/Request.php.
setFormat | ( | $format | ) |
Sets the requested representation format
string | $format | The desired format, something like "html", "xml", "png", "json" or the like. Can even be something like "rss.xml". |
Definition at line 503 of file extbase/Classes/Mvc/Request.php.
References Request\$format.
Referenced by Request\setArgument().
setOriginalRequest | ( | \TYPO3\CMS\Extbase\Mvc\Request | $originalRequest | ) |
\TYPO3\CMS\Extbase\Mvc\Request | $originalRequest |
Definition at line 534 of file extbase/Classes/Mvc/Request.php.
References Request\$originalRequest.
setOriginalRequestMappingResults | ( | \TYPO3\CMS\Extbase\Error\Result | $originalRequestMappingResults | ) |
\TYPO3\CMS\Extbase\Error\Result | $originalRequestMappingResults |
Definition at line 555 of file extbase/Classes/Mvc/Request.php.
References Request\$originalRequestMappingResults.
setPluginName | ( | $pluginName = null | ) |
Sets the plugin name.
string | NULL | $pluginName |
Definition at line 216 of file extbase/Classes/Mvc/Request.php.
References Request\$pluginName.
|
protected |
Definition at line 77 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getArguments(), and Request\getReferringRequest().
|
protected |
Definition at line 72 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerActionName().
|
protected |
Definition at line 50 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerExtensionName(), and Request\setControllerExtensionName().
|
protected |
Definition at line 67 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerName(), and Request\setControllerName().
|
protected |
Definition at line 33 of file extbase/Classes/Mvc/Request.php.
|
protected |
Definition at line 62 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerSubpackageKey().
|
protected |
Definition at line 55 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getControllerVendorName().
|
protected |
Definition at line 97 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\isDispatched().
|
protected |
Definition at line 92 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getFormat(), and Request\setFormat().
|
protected |
Definition at line 87 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getInternalArguments().
|
protected |
Definition at line 40 of file extbase/Classes/Mvc/Request.php.
|
protected |
Definition at line 104 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getOriginalRequest(), and Request\setOriginalRequest().
|
protected |
Definition at line 111 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getOriginalRequestMappingResults(), and Request\setOriginalRequestMappingResults().
|
protected |
Definition at line 45 of file extbase/Classes/Mvc/Request.php.
Referenced by Request\getPluginName(), and Request\setPluginName().
const PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/' |
Definition at line 26 of file extbase/Classes/Mvc/Request.php.