TYPO3\CMS\Extbase\Mvc\RequestInterface Interface Reference

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

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

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Contract for a request.

Definition at line 21 of file RequestInterface.php.

Member Function Documentation

getArgument()

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, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

getArguments()

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, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

getControllerObjectName()

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, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

hasArgument()

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

boolean TRUE if the argument is set, otherwise FALSE

Implemented in TYPO3\CMS\Extbase\Mvc\Request, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

isDispatched()

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

boolean TRUE if this request has been disptached successfully

Implemented in TYPO3\CMS\Extbase\Mvc\Request, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

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

Returns

void

Implemented in TYPO3\CMS\Extbase\Mvc\Request, TYPO3\CMS\Extbase\Mvc\Cli\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

Returns

void

Implemented in TYPO3\CMS\Extbase\Mvc\Request, and TYPO3\CMS\Extbase\Mvc\Cli\Request.

setDispatched()

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

(

$flag

)

Sets the dispatched flag

Parameters

boolean

$flag

If this request has been dispatched

Returns

void

Implemented in TYPO3\CMS\Extbase\Mvc\Request, and TYPO3\CMS\Extbase\Mvc\Cli\Request.