TYPO3\CMS\Extbase\Mvc\RequestInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\RequestInterface:

Public Member Functions
	getPluginName ()
	withPluginName (string $pluginName)
	getControllerExtensionName ()
	withControllerExtensionName (string $controllerExtensionName)
	getControllerExtensionKey ()
	getControllerObjectName ()
	withControllerObjectName (string $controllerObjectName)
	getControllerName ()
	withControllerName (string $controllerName)
	getControllerActionName ()
	withControllerActionName (string $actionName)
	getArgument (string $argumentName)
	hasArgument (string $argumentName)
	withArgument (string $argumentName, mixed $value)
	getArguments ()
	withArguments (array $arguments)
	getFormat ()
	withFormat (string $format)

Detailed Description

Contract for an extbase request.

Definition at line 23 of file RequestInterface.php.

Member Function Documentation

getArgument()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getArgument

(

string

$argumentName

)

Returns the value of the specified argument.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Extensionmanager\Controller\AbstractController\initializeModuleTemplate().

getArguments()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getArguments

(

)

Returns an array of extbase arguments and their values.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Form\Controller\FormEditorController\initializeModuleTemplate(), TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest(), and TYPO3\CMS\IndexedSearch\Controller\AdministrationController\processRequest().

getControllerActionName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getControllerActionName

(

)

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

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Fluid\Core\Rendering\RenderingContext\getControllerAction(), TYPO3\CMS\Extensionmanager\Controller\AbstractController\initializeModuleTemplate(), and TYPO3\CMS\Extbase\Core\Bootstrap\isExtbaseRequestCacheable().

getControllerExtensionKey()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getControllerExtensionKey

(

)

Returns the extension key of the specified controller.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

getControllerExtensionName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getControllerExtensionName

(

)

Returns the extension name of the specified controller.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Extensionmanager\Controller\AbstractController\initializeModuleTemplate().

getControllerName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getControllerName

(

)

Returns the object name of the controller supposed to handle this request, if one was specified already (if not, the name of the default controller is returned)

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Fluid\Core\Rendering\RenderingContext\getControllerName(), and TYPO3\CMS\Extensionmanager\Controller\AbstractController\initializeModuleTemplate().

getControllerObjectName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getControllerObjectName

(

)

Returns the object name of the controller defined by the package key and controller name.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Extbase\Core\Bootstrap\isExtbaseRequestCacheable(), and TYPO3\CMS\Extbase\Mvc\Dispatcher\resolveController().

getFormat()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getFormat

(

)

Returns the requested representation format, something like "html", "xml", "png", "json" or the like.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

getPluginName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::getPluginName

(

)

Returns the plugin key.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

hasArgument()

TYPO3\CMS\Extbase\Mvc\RequestInterface::hasArgument

(

string

$argumentName

)

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

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withArgument()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withArgument	(	string	$argumentName,
		mixed	$value
	)

Return an instance with the specified argument set.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withArguments()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withArguments

(

array

$arguments

)

Return an instance with the specified extbase arguments, replacing any arguments which existed before.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\processRequest().

withControllerActionName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withControllerActionName

(

string

$actionName

)

Return an instance with the specified controller action name set.

Note that the action name must start with a lower case letter and is case-sensitive.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

Referenced by TYPO3\CMS\Extbase\Mvc\Dispatcher\buildRequestFromCurrentRequestAndForwardResponse(), TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest(), and TYPO3\CMS\IndexedSearch\Controller\AdministrationController\processRequest().

withControllerExtensionName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withControllerExtensionName

(

string

$controllerExtensionName

)

Return an instance with the specified controller extension name set.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withControllerName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withControllerName

(

string

$controllerName

)

Return an instance with the specified controller name set.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withControllerObjectName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withControllerObjectName

(

string

$controllerObjectName

)

Return an instance with the specified controller object name set.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withFormat()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withFormat

(

string

$format

)

Return an instance with the specified format. This method allows setting the format as described in getFormat().

Implemented in TYPO3\CMS\Extbase\Mvc\Request.

withPluginName()

TYPO3\CMS\Extbase\Mvc\RequestInterface::withPluginName

(

string

$pluginName

)

Return an instance with the specified plugin name set.

Implemented in TYPO3\CMS\Extbase\Mvc\Request.