TYPO3\CMS\Extbase\Mvc\RequestInterface Interface Reference

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

Public Member Functions
	setDispatched ($flag)
bool	isDispatched ()
string	getControllerObjectName ()
	setArgument ($argumentName, $value)
	setArguments (array $arguments)
string	getArgument ($argumentName)
bool	hasArgument ($argumentName)
array	getArguments ()

Detailed Description

Contract for a request.

Definition at line 21 of file RequestInterface.php.

Member Function Documentation

getArgument()

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

(

$argumentName

)

Returns the value of the specified argument

Parameters

string

$argumentName

‪Name of the argument

Returns

‪string Value of the argument

Exceptions

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

getArguments()

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

(

)

Returns an array of arguments and their values

Returns

‪array Array of arguments and their values (which may be arguments and values as well)

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

getControllerObjectName()

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

(

)

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

Returns

‪string The controller's Object Name

Exceptions

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

Referenced by TYPO3\CMS\Extbase\Mvc\Dispatcher\resolveController().

hasArgument()

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

(

$argumentName

)

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

Parameters

string

$argumentName

‪Name of the argument to check

Returns

‪bool TRUE if the argument is set, otherwise FALSE

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

isDispatched()

bool TYPO3\CMS\Extbase\Mvc\RequestInterface::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

‪bool TRUE if this request has been dispatched successfully

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

Referenced by TYPO3\CMS\Extbase\Mvc\Dispatcher\dispatch(), and TYPO3\CMS\Extbase\Tests\Functional\Mvc\Controller\ActionControllerArgumentTest\dispatch().

setArgument()

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

Sets the value of the specified argument

Parameters

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

Implemented in TYPO3\CMS\Extbase\Mvc\Request, and TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest.

setArguments()

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

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

setDispatched()

TYPO3\CMS\Extbase\Mvc\RequestInterface::setDispatched

(

$flag

)

Sets the dispatched flag

Parameters

bool

$flag

‪If this request has been dispatched

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

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\processRequest().