Inheritance diagram for Tx_Extbase_MVC_Request:

Collaboration diagram for Tx_Extbase_MVC_Request:

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)
	setArguments (array $arguments)
	getArguments ()
	getArgument ($argumentName)
	hasArgument ($argumentName)
	setFormat ($format)
	getFormat ()
	setErrors (array $errors)
	getErrors ()
Public Attributes
const	PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/'
Protected Attributes
	$controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController'
	$pluginName = ''
	$controllerExtensionName = NULL
	$controllerSubpackageKey = NULL
	$controllerName = 'Standard'
	$controllerActionName = 'index'
	$arguments = array()
	$format = 'txt'
	$dispatched = FALSE
	$errors = array()

Detailed Description

Definition at line 37 of file Request.php.

Member Function Documentation

Tx_Extbase_MVC_Request::getArgument ( $ argumentName )

Returns the value of the specified argument

Parameters:

string $argumentName Name of the argument

Returns:: string Value of the argument

Exceptions:

Tx_Extbase_MVC_Exception_NoSuchArgument if such an argument does not exist

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 345 of file Request.php.

Referenced by Tx_Extbase_Security_Channel_RequestHashService\verifyRequest().

Tx_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 Tx_Extbase_MVC_RequestInterface.

Definition at line 333 of file Request.php.

Referenced by Tx_Extbase_Security_Channel_RequestHashService\verifyRequest().

Tx_Extbase_MVC_Request::getControllerActionName ( )

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

Returns:: string Action name

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 290 of file Request.php.

References getControllerObjectName().

Tx_Extbase_MVC_Request::getControllerExtensionKey ( )

Returns the extension name of the specified controller.

Returns:: string The extension key

Definition at line 217 of file Request.php.

References t3lib_div\camelCaseToLowerCaseUnderscored().

Tx_Extbase_MVC_Request::getControllerExtensionName ( )

Returns the extension name of the specified controller.

Returns:: string The extension name

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 207 of file Request.php.

Tx_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

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 263 of file Request.php.

Tx_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:

Tx_Extbase_MVC_Exception_NoSuchController if the controller does not exist

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 128 of file Request.php.

Referenced by getControllerActionName().

Tx_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 237 of file Request.php.

Tx_Extbase_MVC_Request::getErrors ( )

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

Returns:: array The errors that occured during the request

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 398 of file Request.php.

Tx_Extbase_MVC_Request::getFormat ( )

Returns the requested representation format

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

Author:: Robert Lemke <robert@typo3.org>

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 379 of file Request.php.

Tx_Extbase_MVC_Request::getPluginName ( )

Returns the plugin key.

Returns:: string The plugin key

Definition at line 184 of file Request.php.

Tx_Extbase_MVC_Request::hasArgument ( $ argumentName )

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

Parameters:

string $argumentName Name of the argument to check

Returns:: boolean TRUE if the argument is set, otherwise FALSE

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 357 of file Request.php.

Referenced by Tx_Extbase_Security_Channel_RequestHashService\verifyRequest().

Tx_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 Tx_Extbase_MVC_RequestInterface.

Definition at line 116 of file Request.php.

Tx_Extbase_MVC_Request::setArgument	(	$	argumentName,
		$	value
	)

Sets the value of the specified argument

Parameters:

string	$argumentName	Name of the argument to set
mixed	$value	The new value

Returns:: void

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 311 of file Request.php.

References $value.

Tx_Extbase_MVC_Request::setArguments ( array $ arguments )

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

Parameters:

array $arguments An array of argument names and their values

Returns:: void

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 323 of file Request.php.

References $arguments.

Referenced by Tx_Fluid_Core_Widget_AbstractWidgetViewHelper\passArgumentsToSubRequest().

Tx_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 $actionName,: Name of the action to execute by the controller

Returns:: void

Exceptions:

Tx_Extbase_MVC_Exception_InvalidActionName if the action name is not valid

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 276 of file Request.php.

Referenced by Tx_Fluid_Core_Widget_AbstractWidgetViewHelper\passArgumentsToSubRequest().

Tx_Extbase_MVC_Request::setControllerExtensionName ( $ controllerExtensionName )

Sets the extension name of the controller.

Parameters:

string $controllerExtensionName The extension name.

Returns:: void

Exceptions:

Tx_Extbase_MVC_Exception_InvalidExtensionName if the extension name is not valid

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 195 of file Request.php.

References $controllerExtensionName.

Tx_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 $controllerName Name of the controller

Returns:: void

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 248 of file Request.php.

References $controllerName.

Tx_Extbase_MVC_Request::setControllerObjectName ( $ controllerObjectName )

Explicitly sets the object name of the controller

Parameters:

string $controllerObjectName The fully qualified controller object name

Returns:: void

Definition at line 146 of file Request.php.

Referenced by Tx_Fluid_Core_Widget_WidgetRequest\setWidgetContext().

Tx_Extbase_MVC_Request::setControllerSubpackageKey ( $ subpackageKey )

Sets the subpackage key of the controller.

Parameters:

string $subpackageKey The subpackage key.

Returns:: void

Definition at line 227 of file Request.php.

Tx_Extbase_MVC_Request::setDispatched ( $ flag )

Sets the dispatched flag

Parameters:

boolean $flag If this request has been dispatched

Returns:: void

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 102 of file Request.php.

Tx_Extbase_MVC_Request::setErrors ( array $ errors )

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

Parameters:

array $errors An array of Tx_Extbase_Error_Error objects

Returns:: void

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 389 of file Request.php.

References $errors.

Tx_Extbase_MVC_Request::setFormat ( $ format )

Sets the requested representation format

Parameters:

string $format The desired format, something like "html", "xml", "png", "json" or the like. Can even be something like "rss.xml".

Returns:: void

Author:: Robert Lemke <robert@typo3.org>

Implements Tx_Extbase_MVC_RequestInterface.

Definition at line 368 of file Request.php.

References $format.

Tx_Extbase_MVC_Request::setPluginName ( $ pluginName = NULL )

Sets the plugin name.

Parameters:

string $extensionName The plugin name.

Returns:: void

Definition at line 172 of file Request.php.

References $pluginName.

Member Data Documentation

Tx_Extbase_MVC_Request::$arguments = array() [protected]

Definition at line 78 of file Request.php.

Referenced by setArguments().

Tx_Extbase_MVC_Request::$controllerActionName = 'index' [protected]

Definition at line 73 of file Request.php.

Tx_Extbase_MVC_Request::$controllerExtensionName = NULL [protected]

Definition at line 56 of file Request.php.

Referenced by setControllerExtensionName().

Tx_Extbase_MVC_Request::$controllerName = 'Standard' [protected]

Definition at line 68 of file Request.php.

Referenced by setControllerName().

Tx_Extbase_MVC_Request::$controllerObjectNamePattern = 'Tx_@extension_@subpackage_Controller_@controllerController' [protected]

Definition at line 46 of file Request.php.

Tx_Extbase_MVC_Request::$controllerSubpackageKey = NULL [protected]

Definition at line 63 of file Request.php.

Tx_Extbase_MVC_Request::$dispatched = FALSE [protected]

Definition at line 88 of file Request.php.

Tx_Extbase_MVC_Request::$errors = array() [protected]

Definition at line 93 of file Request.php.

Referenced by setErrors().

Tx_Extbase_MVC_Request::$format = 'txt' [protected]

Reimplemented in Tx_Extbase_MVC_Web_Request.

Definition at line 83 of file Request.php.

Referenced by setFormat().

Tx_Extbase_MVC_Request::$pluginName = '' [protected]

Definition at line 51 of file Request.php.

Referenced by setPluginName().

const Tx_Extbase_MVC_Request::PATTERN_MATCH_FORMAT = '/^[a-z0-9]{1,5}$/'

Definition at line 39 of file Request.php.

The documentation for this class was generated from the following file:

typo3/sysext/extbase/Classes/MVC/Request.php

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation