Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Cli\Request:

Public Member Functions
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)

	setCallingScript ($callingScript)

string	getCallingScript ()

	setDispatched ($flag)

bool	isDispatched ()

	setControllerObjectName ($controllerObjectName)

string	getControllerObjectName ()

string	getControllerExtensionName ()

	setControllerCommandName ($commandName)

string	getControllerCommandName ()

TYPO3 CMS Extbase Mvc Cli Command	getCommand ()

	setArgument ($argumentName, $value)

	setArguments (array $arguments)

string	getArgument ($argumentName)

bool	hasArgument ($argumentName)

array	getArguments ()

	setExceedingArguments (array $exceedingArguments)

array	getExceedingArguments ()

Protected Attributes
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager

string	$controllerObjectName

string	$controllerCommandName = 'default'

string	$controllerExtensionName

array	$arguments = array( )

array	$exceedingArguments = array( )

bool	$dispatched = false

array	$commandLineArguments

TYPO3 CMS Extbase Mvc Cli Command	$command

string	$callingScript

Detailed Description

Represents a CLI request.

Deprecated:: ‪since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.

Definition at line 22 of file Request.php.

Member Function Documentation

◆ getArgument()

string TYPO3\CMS\Extbase\Mvc\Cli\Request::getArgument ( $argumentName )

Returns the value of the specified argument

Parameters

string $argumentName ‪Name of the argument

Returns: ‪string Value of the argument

Exceptions

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 219 of file Request.php.

◆ getArguments()

array TYPO3\CMS\Extbase\Mvc\Cli\Request::getArguments ( )

Returns an ArrayObject of arguments and their values

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

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 243 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$arguments.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\processRequest(), TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons(), TYPO3\CMS\Beuser\Controller\PermissionController\registerDocHeaderButtons(), and TYPO3\CMS\Form\Controller\FormManagerController\registerDocheaderButtons().

◆ getCallingScript()

string TYPO3\CMS\Extbase\Mvc\Cli\Request::getCallingScript ( )

Returns: ‪string

Definition at line 87 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$callingScript.

◆ getCommand()

TYPO3 CMS Extbase Mvc Cli Command TYPO3\CMS\Extbase\Mvc\Cli\Request::getCommand ( )

Returns the command object for this request

Returns: ‪\TYPO3\CMS\Extbase\Mvc\Cli\Command

Definition at line 178 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$command.

◆ getControllerCommandName()

string TYPO3\CMS\Extbase\Mvc\Cli\Request::getControllerCommandName ( )

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

Returns: ‪string Command name

Definition at line 168 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$controllerCommandName.

◆ getControllerExtensionName()

string TYPO3\CMS\Extbase\Mvc\Cli\Request::getControllerExtensionName ( )

Returns the extension name of the specified controller.

Returns: ‪string The extension name

Definition at line 145 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$controllerExtensionName.

◆ getControllerObjectName()

string TYPO3\CMS\Extbase\Mvc\Cli\Request::getControllerObjectName ( )

Returns the object name of the controller

Returns: ‪string The controller's object name

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 135 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$controllerObjectName.

Referenced by OliverHader\IrreTutorial\Controller\QueueController\resolveController().

◆ getExceedingArguments()

array TYPO3\CMS\Extbase\Mvc\Cli\Request::getExceedingArguments ( )

Returns additional unnamed arguments (if any) which have been passed through the command line after all required arguments (if any) have been specified.

For a command method with the signature ($argument1, $argument2) and for the command line typo3/sysext/core/bin/typo3 acme:foo –argument1 Foo –argument2 Bar baz quux this method would return array(0 => 'baz', 1 => 'quux')

Returns: ‪array Numeric array of exceeding argument values

Definition at line 268 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$exceedingArguments.

◆ hasArgument()

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

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 233 of file Request.php.

◆ injectObjectManager()

TYPO3\CMS\Extbase\Mvc\Cli\Request::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager )

Parameters

\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager

Definition at line 71 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$objectManager.

◆ isDispatched()

bool TYPO3\CMS\Extbase\Mvc\Cli\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: ‪bool TRUE if this request has been disptached successfully

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 111 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$dispatched.

◆ setArgument()

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

Exceptions

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 193 of file Request.php.

◆ setArguments()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setArguments ( array $arguments )

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

Parameters

array $arguments ‪An array of argument names and their values

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 207 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$arguments.

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

◆ setCallingScript()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setCallingScript ( $callingScript )

Parameters

string $callingScript

Definition at line 79 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$callingScript.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\RequestBuilder\build().

◆ setControllerCommandName()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setControllerCommandName ( $commandName )

Sets the name of the command contained in this request.

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

Parameters

string $commandName ‪Name of the command to execute by the controller

Definition at line 157 of file Request.php.

◆ setControllerObjectName()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setControllerObjectName ( $controllerObjectName )

Sets the object name of the controller

Parameters

string $controllerObjectName ‪The fully qualified controller object name

Definition at line 121 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$controllerObjectName, and TYPO3\CMS\Core\Utility\ClassNamingUtility\explodeObjectControllerName().

◆ setDispatched()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setDispatched ( $flag )

Sets the dispatched flag

Parameters

bool $flag ‪If this request has been dispatched

Implements TYPO3\CMS\Extbase\Mvc\RequestInterface.

Definition at line 97 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\processRequest(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\processRequest().

◆ setExceedingArguments()

TYPO3\CMS\Extbase\Mvc\Cli\Request::setExceedingArguments ( array $exceedingArguments )

Sets the exceeding arguments

Parameters

array $exceedingArguments ‪Numeric array of exceeding arguments

Definition at line 253 of file Request.php.

References TYPO3\CMS\Extbase\Mvc\Cli\Request\$exceedingArguments.

Member Data Documentation

◆ $arguments

array TYPO3\CMS\Extbase\Mvc\Cli\Request::$arguments = array( )

protected

The arguments for this request

Definition at line 44 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getArguments(), and TYPO3\CMS\Extbase\Mvc\Cli\Request\setArguments().

◆ $callingScript

string TYPO3\CMS\Extbase\Mvc\Cli\Request::$callingScript

protected

Definition at line 66 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getCallingScript(), and TYPO3\CMS\Extbase\Mvc\Cli\Request\setCallingScript().

◆ $command

TYPO3 CMS Extbase Mvc Cli Command TYPO3\CMS\Extbase\Mvc\Cli\Request::$command

protected

| NULL

Definition at line 62 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getCommand().

◆ $commandLineArguments

array TYPO3\CMS\Extbase\Mvc\Cli\Request::$commandLineArguments

protected

Definition at line 58 of file Request.php.

◆ $controllerCommandName

string TYPO3\CMS\Extbase\Mvc\Cli\Request::$controllerCommandName = 'default'

protected

Definition at line 34 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getControllerCommandName().

◆ $controllerExtensionName

string TYPO3\CMS\Extbase\Mvc\Cli\Request::$controllerExtensionName

protected

Name of the extension which is supposed to handle this request.

Definition at line 38 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getControllerExtensionName().

◆ $controllerObjectName

string TYPO3\CMS\Extbase\Mvc\Cli\Request::$controllerObjectName

protected

Definition at line 30 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getControllerObjectName(), and TYPO3\CMS\Extbase\Mvc\Cli\Request\setControllerObjectName().

◆ $dispatched

bool TYPO3\CMS\Extbase\Mvc\Cli\Request::$dispatched = false

protected

If this request has been changed and needs to be dispatched again

Definition at line 54 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\isDispatched().

◆ $exceedingArguments

array TYPO3\CMS\Extbase\Mvc\Cli\Request::$exceedingArguments = array( )

protected

Definition at line 48 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\getExceedingArguments(), and TYPO3\CMS\Extbase\Mvc\Cli\Request\setExceedingArguments().

◆ $objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Extbase\Mvc\Cli\Request::$objectManager

protected

Definition at line 26 of file Request.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Request\injectObjectManager().

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getArgument()

◆ getArguments()

◆ getCallingScript()

◆ getCommand()

◆ getControllerCommandName()

◆ getControllerExtensionName()

◆ getControllerObjectName()

◆ getExceedingArguments()

◆ hasArgument()

◆ injectObjectManager()

◆ isDispatched()

◆ setArgument()

◆ setArguments()

◆ setCallingScript()

◆ setControllerCommandName()

◆ setControllerObjectName()

◆ setDispatched()

◆ setExceedingArguments()

Member Data Documentation

◆ $arguments

◆ $callingScript

◆ $command

◆ $commandLineArguments

◆ $controllerCommandName

◆ $controllerExtensionName

◆ $controllerObjectName

◆ $dispatched

◆ $exceedingArguments

◆ $objectManager