![]() |
TYPO3
7.6
|
Public Member Functions | |
injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager) | |
setCallingScript ($callingScript) | |
getCallingScript () | |
setDispatched ($flag) | |
isDispatched () | |
setControllerObjectName ($controllerObjectName) | |
getControllerObjectName () | |
getControllerExtensionName () | |
setControllerCommandName ($commandName) | |
getControllerCommandName () | |
getCommand () | |
setArgument ($argumentName, $value) | |
setArguments (array $arguments) | |
getArgument ($argumentName) | |
hasArgument ($argumentName) | |
getArguments () | |
setExceedingArguments (array $exceedingArguments) | |
getExceedingArguments () | |
Protected Attributes | |
$objectManager | |
$controllerObjectName | |
$controllerCommandName = 'default' | |
$controllerExtensionName = null | |
$arguments = array() | |
$exceedingArguments = array() | |
$dispatched = false | |
$commandLineArguments | |
$command = null | |
$callingScript | |
Represents a CLI request.
http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
Definition at line 23 of file extbase/Classes/Mvc/Cli/Request.php.
getArgument | ( | $argumentName | ) |
Returns the value of the specified argument
string | $argumentName | Name of the argument |
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException | if such an argument does not exist |
Implements RequestInterface.
Definition at line 235 of file extbase/Classes/Mvc/Cli/Request.php.
getArguments | ( | ) |
Returns an ArrayObject of arguments and their values
Implements RequestInterface.
Definition at line 259 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$arguments.
getCallingScript | ( | ) |
Definition at line 98 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$callingScript.
getCommand | ( | ) |
Returns the command object for this request
Definition at line 192 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$command.
getControllerCommandName | ( | ) |
Returns the name of the command the controller is supposed to execute.
Definition at line 182 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$controllerCommandName.
getControllerExtensionName | ( | ) |
Returns the extension name of the specified controller.
Definition at line 158 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$controllerExtensionName.
getControllerObjectName | ( | ) |
Returns the object name of the controller
Implements RequestInterface.
Definition at line 148 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$controllerObjectName.
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 cli_dispatch.phpsh extbase some-key someaction acme:foo –argument1 Foo –argument2 Bar baz quux this method would return array(0 => 'baz', 1 => 'quux')
Definition at line 285 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$exceedingArguments.
hasArgument | ( | $argumentName | ) |
Checks if an argument of the given name exists (is set)
string | $argumentName | Name of the argument to check |
Implements RequestInterface.
Definition at line 249 of file extbase/Classes/Mvc/Cli/Request.php.
injectObjectManager | ( | \TYPO3\CMS\Extbase\Object\ObjectManagerInterface | $objectManager | ) |
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface | $objectManager |
Definition at line 82 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$objectManager.
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.
Implements RequestInterface.
Definition at line 123 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$dispatched.
setArgument | ( | $argumentName, | |
$value | |||
) |
Sets the value of the specified argument
string | $argumentName | Name of the argument to set |
mixed | $value | The new value |
\TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentNameException |
Implements RequestInterface.
Definition at line 208 of file extbase/Classes/Mvc/Cli/Request.php.
setArguments | ( | array | $arguments | ) |
Sets the whole arguments ArrayObject and therefore replaces any arguments which existed before.
array | $arguments | An array of argument names and their values |
Implements RequestInterface.
Definition at line 223 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$arguments.
setCallingScript | ( | $callingScript | ) |
string | $callingScript |
Definition at line 90 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$callingScript.
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.
string | $commandName | Name of the command to execute by the controller |
Definition at line 171 of file extbase/Classes/Mvc/Cli/Request.php.
setControllerObjectName | ( | $controllerObjectName | ) |
Sets the object name of the controller
string | $controllerObjectName | The fully qualified controller object name |
Definition at line 134 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$controllerObjectName.
setDispatched | ( | $flag | ) |
Sets the dispatched flag
bool | $flag | If this request has been dispatched |
Implements RequestInterface.
Definition at line 109 of file extbase/Classes/Mvc/Cli/Request.php.
setExceedingArguments | ( | array | $exceedingArguments | ) |
Sets the exceeding arguments
array | $exceedingArguments | Numeric array of exceeding arguments |
Definition at line 270 of file extbase/Classes/Mvc/Cli/Request.php.
References Request\$exceedingArguments.
|
protected |
Definition at line 50 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getArguments(), and Request\setArguments().
|
protected |
Definition at line 77 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getCallingScript(), and Request\setCallingScript().
|
protected |
Definition at line 72 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getCommand().
|
protected |
Definition at line 67 of file extbase/Classes/Mvc/Cli/Request.php.
|
protected |
Definition at line 38 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getControllerCommandName().
|
protected |
Definition at line 43 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getControllerExtensionName().
|
protected |
Definition at line 33 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getControllerObjectName(), and Request\setControllerObjectName().
|
protected |
Definition at line 62 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\isDispatched().
|
protected |
Definition at line 55 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\getExceedingArguments(), and Request\setExceedingArguments().
|
protected |
Definition at line 28 of file extbase/Classes/Mvc/Cli/Request.php.
Referenced by Request\injectObjectManager().