TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Mvc\Request Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Request:
TYPO3\CMS\Extbase\Mvc\RequestInterface Tx_Extbase_MVC_Request TYPO3\CMS\Extbase\Mvc\Web\Request Tx_Extbase_MVC_Web_Request TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest TYPO3\CMS\Fluid\Core\Widget\WidgetRequest Tx_Fluid_Core_Widget_WidgetRequest

Public Member Functions

 setDispatched ($flag)
 
 isDispatched ()
 
 getControllerObjectName ()
 
 setControllerObjectName ($controllerObjectName)
 
 setPluginName ($pluginName=NULL)
 
 getPluginName ()
 
 setControllerExtensionName ($controllerExtensionName)
 
 getControllerExtensionName ()
 
 getControllerExtensionKey ()
 
 setControllerSubpackageKey ($subpackageKey)
 
 getControllerSubpackageKey ()
 
 setControllerName ($controllerName)
 
 getControllerName ()
 
 setControllerActionName ($actionName)
 
 getControllerActionName ()
 
 setArgument ($argumentName, $value)
 
 setControllerVendorName ($vendorName)
 
 getControllerVendorName ()
 
 setArguments (array $arguments)
 
 getArguments ()
 
 getArgument ($argumentName)
 
 hasArgument ($argumentName)
 
 setFormat ($format)
 
 getFormat ()
 
 setErrors (array $errors)
 
 getErrors ()
 
 getOriginalRequest ()
 
 setOriginalRequest (\TYPO3\CMS\Extbase\Mvc\Request $originalRequest)
 
 getOriginalRequestMappingResults ()
 
 setOriginalRequestMappingResults (\TYPO3\CMS\Extbase\Error\Result $originalRequestMappingResults)
 
 getInternalArguments ()
 
 getInternalArgument ($argumentName)
 

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
 
 $errors = array()
 

Detailed Description

Represents a generic request.

Definition at line 24 of file Request.php.

Member Function Documentation

◆ getArgument()

TYPO3\CMS\Extbase\Mvc\Request::getArgument (   $argumentName)

Returns the value of the specified argument

Parameters
string$argumentNameName of the argument
Returns
string Value of the argument
Exceptions

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 443 of file Request.php.

◆ getArguments()

TYPO3\CMS\Extbase\Mvc\Request::getArguments ( )

Returns an array of arguments and their values

Returns
array Associative array of arguments and their values (which may be arguments and values as well)

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 430 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$arguments.

◆ getControllerActionName()

TYPO3\CMS\Extbase\Mvc\Request::getControllerActionName ( )

Returns the name of the action the controller is supposed to execute.

Returns
string Action name

Definition at line 350 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerActionName, and TYPO3\CMS\Extbase\Mvc\Request\getControllerObjectName().

◆ getControllerExtensionKey()

TYPO3\CMS\Extbase\Mvc\Request::getControllerExtensionKey ( )

Returns the extension name of the specified controller.

Returns
string The extension key

Definition at line 265 of file Request.php.

◆ getControllerExtensionName()

TYPO3\CMS\Extbase\Mvc\Request::getControllerExtensionName ( )

Returns the extension name of the specified controller.

Returns
string The extension name

Definition at line 255 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerExtensionName.

◆ getControllerName()

TYPO3\CMS\Extbase\Mvc\Request::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)

Returns
string Object name of the controller

Definition at line 318 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerName.

◆ getControllerObjectName()

TYPO3\CMS\Extbase\Mvc\Request::getControllerObjectName ( )

Returns the object name of the controller defined by the extension name and controller name

Returns
string The controller's Object Name
Exceptions

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 153 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerActionName().

◆ getControllerSubpackageKey()

TYPO3\CMS\Extbase\Mvc\Request::getControllerSubpackageKey ( )

Returns the subpackage key of the specified controller. If there is no subpackage key set, the method returns NULL

Returns
string The subpackage key

Definition at line 286 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerSubpackageKey.

◆ getControllerVendorName()

TYPO3\CMS\Extbase\Mvc\Request::getControllerVendorName ( )

get the VendorName

Returns
string

Definition at line 405 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerVendorName.

◆ getErrors()

TYPO3\CMS\Extbase\Mvc\Request::getErrors ( )

Get errors that occurred during the request (e.g. argument mapping errors)

Returns
array The errors that occurred during the request
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 501 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$errors.

◆ getFormat()

TYPO3\CMS\Extbase\Mvc\Request::getFormat ( )

Returns the requested representation format

Returns
string The desired format, something like "html", "xml", "png", "json" or the like.

Definition at line 479 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$format.

◆ getInternalArgument()

TYPO3\CMS\Extbase\Mvc\Request::getInternalArgument (   $argumentName)

Returns the value of the specified argument

Parameters
string$argumentNameName of the argument
Returns
string Value of the argument, or NULL if not set.

Definition at line 559 of file Request.php.

◆ getInternalArguments()

TYPO3\CMS\Extbase\Mvc\Request::getInternalArguments ( )

Get the internal arguments of the request, i.e. every argument starting with two underscores.

Returns
array

Definition at line 548 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$internalArguments.

◆ getOriginalRequest()

TYPO3\CMS\Extbase\Mvc\Request::getOriginalRequest ( )

Returns the original request. Filled only if a property mapping error occurred.

Returns
the original request.

Definition at line 510 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$originalRequest.

◆ getOriginalRequestMappingResults()

TYPO3\CMS\Extbase\Mvc\Request::getOriginalRequestMappingResults ( )

Get the request mapping results for the original request.

Returns

Definition at line 528 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$originalRequestMappingResults.

◆ getPluginName()

TYPO3\CMS\Extbase\Mvc\Request::getPluginName ( )

Returns the plugin key.

Returns
string The plugin key

Definition at line 231 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$pluginName.

◆ hasArgument()

TYPO3\CMS\Extbase\Mvc\Request::hasArgument (   $argumentName)

Checks if an argument of the given name exists (is set)

Parameters
string$argumentNameName of the argument to check
Returns
boolean TRUE if the argument is set, otherwise FALSE

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 458 of file Request.php.

◆ isDispatched()

TYPO3\CMS\Extbase\Mvc\Request::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.

Returns
boolean TRUE if this request has been disptached sucessfully

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 141 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$dispatched.

◆ setArgument()

TYPO3\CMS\Extbase\Mvc\Request::setArgument (   $argumentName,
  $value 
)

Sets the value of the specified argument

Parameters
string$argumentNameName of the argument to set
mixed$valueThe new value
Exceptions
Exception

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 376 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\setArguments().

◆ setArguments()

TYPO3\CMS\Extbase\Mvc\Request::setArguments ( array  $arguments)

Sets the whole arguments array and therefore replaces any arguments which existed before.

Parameters
array$argumentsAn array of argument names and their values
Returns
void

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 417 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\setArgument().

◆ setControllerActionName()

TYPO3\CMS\Extbase\Mvc\Request::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.

Parameters
string$actionNameName of the action to execute by the controller
Returns
void
Exceptions

Definition at line 332 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setControllerExtensionName()

TYPO3\CMS\Extbase\Mvc\Request::setControllerExtensionName (   $controllerExtensionName)

Sets the extension name of the controller.

Parameters
string$controllerExtensionNameThe extension name.
Returns
void
Exceptions

Definition at line 243 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerExtensionName.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setControllerName()

TYPO3\CMS\Extbase\Mvc\Request::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!

Parameters
string$controllerNameName of the controller
Exceptions
Exception

Definition at line 299 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$controllerName.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setControllerObjectName()

TYPO3\CMS\Extbase\Mvc\Request::setControllerObjectName (   $controllerObjectName)

Explicitly sets the object name of the controller

Parameters
string$controllerObjectNameThe fully qualified controller object name
Returns
void

Definition at line 204 of file Request.php.

References TYPO3\CMS\Core\Utility\ClassNamingUtility\explodeObjectControllerName().

Referenced by TYPO3\CMS\Fluid\Core\Widget\WidgetRequest\setWidgetContext().

◆ setControllerSubpackageKey()

TYPO3\CMS\Extbase\Mvc\Request::setControllerSubpackageKey (   $subpackageKey)

Sets the subpackage key of the controller.

Parameters
string$subpackageKeyThe subpackage key.
Returns
void

Definition at line 276 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setControllerVendorName()

TYPO3\CMS\Extbase\Mvc\Request::setControllerVendorName (   $vendorName)

sets the VendorName

Parameters
string$vendorName
Returns
void

Definition at line 396 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setDispatched()

TYPO3\CMS\Extbase\Mvc\Request::setDispatched (   $flag)

Sets the dispatched flag

Parameters
boolean$flagIf this request has been dispatched
Returns
void

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 127 of file Request.php.

◆ setErrors()

TYPO3\CMS\Extbase\Mvc\Request::setErrors ( array  $errors)

Set errors that occurred during the request (e.g. argument mapping errors)

Parameters
array$errorsAn array of objects
Returns
void
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 491 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$errors.

◆ setFormat()

TYPO3\CMS\Extbase\Mvc\Request::setFormat (   $format)

Sets the requested representation format

Parameters
string$formatThe desired format, something like "html", "xml", "png", "json" or the like. Can even be something like "rss.xml".
Returns
void

Definition at line 469 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$format.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest\setArgument().

◆ setOriginalRequest()

TYPO3\CMS\Extbase\Mvc\Request::setOriginalRequest ( \TYPO3\CMS\Extbase\Mvc\Request  $originalRequest)
Parameters
\TYPO3\CMS\Extbase\Mvc\Request$originalRequest
Returns
void

Definition at line 519 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$originalRequest.

◆ setOriginalRequestMappingResults()

TYPO3\CMS\Extbase\Mvc\Request::setOriginalRequestMappingResults ( \TYPO3\CMS\Extbase\Error\Result  $originalRequestMappingResults)
Parameters
\TYPO3\CMS\Extbase\Error\Result$originalRequestMappingResults

Definition at line 538 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$originalRequestMappingResults.

◆ setPluginName()

TYPO3\CMS\Extbase\Mvc\Request::setPluginName (   $pluginName = NULL)

Sets the plugin name.

Parameters
string | NULL$pluginName
Returns
void

Definition at line 219 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Request\$pluginName.

Member Data Documentation

◆ $arguments

TYPO3\CMS\Extbase\Mvc\Request::$arguments = array()
protected

Definition at line 77 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getArguments(), and TYPO3\CMS\Extbase\Mvc\Web\Request\getReferringRequest().

◆ $controllerActionName

TYPO3\CMS\Extbase\Mvc\Request::$controllerActionName = 'index'
protected

Definition at line 72 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerActionName().

◆ $controllerExtensionName

TYPO3\CMS\Extbase\Mvc\Request::$controllerExtensionName = NULL
protected

Definition at line 50 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerExtensionName(), and TYPO3\CMS\Extbase\Mvc\Request\setControllerExtensionName().

◆ $controllerName

TYPO3\CMS\Extbase\Mvc\Request::$controllerName = 'Standard'
protected

Definition at line 67 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerName(), and TYPO3\CMS\Extbase\Mvc\Request\setControllerName().

◆ $controllerObjectNamePattern

TYPO3\CMS\Extbase\Mvc\Request::$controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController'
protected

Definition at line 33 of file Request.php.

◆ $controllerSubpackageKey

TYPO3\CMS\Extbase\Mvc\Request::$controllerSubpackageKey = NULL
protected

Definition at line 62 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerSubpackageKey().

◆ $controllerVendorName

TYPO3\CMS\Extbase\Mvc\Request::$controllerVendorName = NULL
protected

Definition at line 55 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getControllerVendorName().

◆ $dispatched

TYPO3\CMS\Extbase\Mvc\Request::$dispatched = FALSE
protected

Definition at line 97 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\isDispatched().

◆ $errors

TYPO3\CMS\Extbase\Mvc\Request::$errors = array()
protected

Definition at line 117 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getErrors(), and TYPO3\CMS\Extbase\Mvc\Request\setErrors().

◆ $format

TYPO3\CMS\Extbase\Mvc\Request::$format = 'txt'
protected

Definition at line 92 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getFormat(), and TYPO3\CMS\Extbase\Mvc\Request\setFormat().

◆ $internalArguments

TYPO3\CMS\Extbase\Mvc\Request::$internalArguments = array()
protected

Definition at line 87 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getInternalArguments().

◆ $namespacedControllerObjectNamePattern

TYPO3\CMS\Extbase\Mvc\Request::$namespacedControllerObjectNamePattern = '@vendor\@extension\@subpackage\Controller\@controllerController'
protected

Definition at line 40 of file Request.php.

◆ $originalRequest

TYPO3\CMS\Extbase\Mvc\Request::$originalRequest = NULL
protected

Definition at line 104 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getOriginalRequest(), and TYPO3\CMS\Extbase\Mvc\Request\setOriginalRequest().

◆ $originalRequestMappingResults

TYPO3\CMS\Extbase\Mvc\Request::$originalRequestMappingResults = NULL
protected

Definition at line 111 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getOriginalRequestMappingResults(), and TYPO3\CMS\Extbase\Mvc\Request\setOriginalRequestMappingResults().

◆ $pluginName

TYPO3\CMS\Extbase\Mvc\Request::$pluginName = ''
protected

Definition at line 45 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Request\getPluginName(), and TYPO3\CMS\Extbase\Mvc\Request\setPluginName().

◆ PATTERN_MATCH_FORMAT

const TYPO3\CMS\Extbase\Mvc\Request::PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/'

Definition at line 26 of file Request.php.