‪TYPO3CMS  11.5
TYPO3\CMS\Extbase\Mvc\RequestInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Extbase\Mvc\RequestInterface:
TYPO3\CMS\Extbase\Mvc\Request TYPO3\CMS\Extbase\Mvc\Web\ReferringRequest

Public Member Functions

string getControllerObjectName ()
 
string array getArgument ($argumentName)
 
 hasArgument ($argumentName)
 
 getArguments ()
 

Detailed Description

Contract for an extbase request.

Todo:
‪v12: interface RequestInterface extends ServerRequestInterface

Definition at line 26 of file RequestInterface.php.

Member Function Documentation

◆ getArgument()

string array TYPO3\CMS\Extbase\Mvc\RequestInterface::getArgument (   $argumentName)

Return an instance with the specified controller object name set.

Todo:
‪v12: Enable

Return an instance with the specified controller alias to class name mapping set.

Todo:
‪v12: Enable or refactor to render it obsolete.

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)

Todo:
‪v12: Enable

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

Todo:
‪v12: Enable

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.

Parameters
string|null‪Action name
Returns
‪self
Todo:
‪v12: Enable

Returns the value of the specified argument.

Parameters
string$argumentName‪Name of the argument
Returns
‪string|array Value of the argument
Exceptions
NoSuchArgumentException‪if such an argument does not exist
Todo:
‪v12: public function getArgument(string $argumentName)

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

◆ getArguments()

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

Return an instance with the specified argument set.

Parameters
string$argumentName‪Name of the argument to set
mixed$value‪The new value
Returns
RequestInterface
Todo:
‪v12: Enable

Returns an array of extbase arguments and their values.

Todo:
‪v12: public function getArguments(): array

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

◆ getControllerObjectName()

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

Returns the plugin key.

Todo:
‪v12: Enable

Return an instance with the specified plugin name set.

Parameters
string|null‪Plugin name
Returns
‪self
Todo:
‪v12: Enable

Returns the extension name of the specified controller.

Returns
‪string|null
Todo:
‪v12: Enable

Return an instance with the specified controller extension name set.

Parameters
string|null‪Extension name
Returns
‪self
Todo:
‪v12: Enable

Returns the extension key of the specified controller.

Todo:
‪v12: Enable

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

Returns
‪string The controller's Object Name
Todo:
‪v12: public function getControllerObjectName(): string

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

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

◆ hasArgument()

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

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

Todo:
‪v12: public function hasArgument(string $argumentName): bool

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