TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CommandController Class Reference
Inheritance diagram for CommandController:
CommandControllerInterface ControllerInterface HelpCommandController ExtensionCommandController LanguageCommandController

Public Member Functions

 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 processRequest (RequestInterface $request, ResponseInterface $response)
 

Protected Member Functions

 resolveCommandMethodName ()
 
 initializeCommandMethodArguments ()
 
 forward ($commandName, $controllerObjectName=null, array $arguments=array())
 
 ensureAdminRoleIfRequested ()
 
 restoreUserRole ($originalRole)
 
 output ($text, array $arguments=array())
 
 outputLine ($text= '', array $arguments=array())
 
 outputFormatted ($text= '', array $arguments=array(), $leftPadding=0)
 
 quit ($exitCode=0)
 
 sendAndExit ($exitCode=0)
 

Protected Attributes

 $request
 
 $response
 
 $arguments
 
 $commandMethodName = ''
 
 $requestAdminPermissions = false
 
 $userAuthentication
 
 $reflectionService
 
 $objectManager
 
 $output
 

Detailed Description

A controller which processes requests from the command line

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 34 of file CommandController.php.

Member Function Documentation

canProcessRequest ( \TYPO3\CMS\Extbase\Mvc\RequestInterface  $request)

Checks if the current request type is supported by the controller.

Parameters
\TYPO3\CMS\Extbase\Mvc\RequestInterface$requestThe current request
Returns
bool TRUE if this request type is supported, otherwise FALSE

Implements ControllerInterface.

Definition at line 112 of file CommandController.php.

Referenced by CommandController\processRequest().

ensureAdminRoleIfRequested ( )
protected

Set admin permissions for currently authenticated user if requested and returns the original state or NULL

Returns
NULL|int

Definition at line 272 of file CommandController.php.

forward (   $commandName,
  $controllerObjectName = null,
array  $arguments = array() 
)
protected

Forwards the request to another command and / or CommandController.

Request is directly transferred to the other command / controller without the need for a new request.

Parameters
string$commandName
string$controllerObjectName
array$arguments
Returns
void
Exceptions
StopActionException

Definition at line 227 of file CommandController.php.

References CommandController\$arguments.

initializeCommandMethodArguments ( )
protected

Initializes the arguments array of this controller by creating an empty argument object for each of the method arguments found in the designated command method.

Exceptions
\TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentTypeException
Returns
void
Exceptions
InvalidArgumentTypeException

Definition at line 169 of file CommandController.php.

References elseif.

Referenced by CommandController\processRequest().

injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager
Returns
void

Definition at line 90 of file CommandController.php.

References $GLOBALS, CommandController\$objectManager, and CommandController\output().

injectReflectionService ( \TYPO3\CMS\Extbase\Reflection\ReflectionService  $reflectionService)
Parameters
\TYPO3\CMS\Extbase\Reflection\ReflectionService$reflectionService

Definition at line 101 of file CommandController.php.

References CommandController\$reflectionService.

output (   $text,
array  $arguments = array() 
)
protected

Outputs specified text to the console window You can specify arguments that will be passed to the text via sprintf

See Also
http://www.php.net/sprintf
Parameters
string$textText to output
array$argumentsOptional arguments to use for sprintf
Returns
void

Definition at line 303 of file CommandController.php.

References CommandController\$arguments.

Referenced by HelpCommandController\displayHelpForCommand(), HelpCommandController\displayHelpIndex(), ExtensionCommandController\dumpClassLoadingInformationCommand(), CommandController\injectObjectManager(), CommandController\outputFormatted(), and CommandController\outputLine().

outputFormatted (   $text = '',
array  $arguments = array(),
  $leftPadding = 0 
)
protected

Formats the given text to fit into MAXIMUM_LINE_LENGTH and outputs it to the console window

Parameters
string$textText to output
array$argumentsOptional arguments to use for sprintf
int$leftPaddingThe number of spaces to use for indentation
Returns
void
See Also
outputLine()

Definition at line 331 of file CommandController.php.

References CommandController\$arguments, and CommandController\output().

outputLine (   $text = '',
array  $arguments = array() 
)
protected

Outputs specified text to the console window and appends a line break

Parameters
string$textText to output
array$argumentsOptional arguments to use for sprintf
Returns
void
See Also
output()

Definition at line 316 of file CommandController.php.

References CommandController\$arguments, and CommandController\output().

Referenced by HelpCommandController\displayHelpForCommand(), HelpCommandController\displayHelpIndex(), HelpCommandController\errorCommand(), HelpCommandController\helpCommand(), and HelpCommandController\helpStubCommand().

processRequest ( RequestInterface  $request,
ResponseInterface  $response 
)

Processes a command line request.

Parameters
RequestInterface$requestThe request object
ResponseInterface$responseThe response, modified by this handler
Returns
void
Exceptions
UnsupportedRequestTypeExceptionif the controller doesn't support the current request type

Definition at line 126 of file CommandController.php.

References CommandController\$request, CommandController\$response, CommandController\canProcessRequest(), CommandController\initializeCommandMethodArguments(), and CommandController\resolveCommandMethodName().

quit (   $exitCode = 0)
protected

Exits the CLI through the dispatcher An exit status code can be specified

See Also
http://www.php.net/exit
Parameters
int$exitCodeExit code to return on exit
Exceptions
StopActionException
Returns
void

Definition at line 344 of file CommandController.php.

Referenced by ExtensionCommandController\dumpClassLoadingInformationCommand().

resolveCommandMethodName ( )
protected

Resolves and checks the current command method name

Note: The resulting command method name might not have the correct case, which isn't a problem because PHP is case insensitive regarding method names.

Exceptions
\TYPO3\CMS\Extbase\Mvc\Exception\NoSuchCommandException
Returns
string Method name of the current command
Exceptions
NoSuchCommandException

Definition at line 152 of file CommandController.php.

References CommandController\$commandMethodName.

Referenced by CommandController\processRequest().

restoreUserRole (   $originalRole)
protected

Restores the original user role

Parameters
NULL | int$originalRole

Definition at line 287 of file CommandController.php.

sendAndExit (   $exitCode = 0)
protected

Sends the response and exits the CLI without any further code execution Should be used for commands that flush code caches.

Parameters
int$exitCodeExit code to return on exit
Returns
void

Definition at line 357 of file CommandController.php.

Member Data Documentation

$arguments
protected
$commandMethodName = ''
protected

Definition at line 56 of file CommandController.php.

Referenced by CommandController\resolveCommandMethodName().

$objectManager
protected

Definition at line 79 of file CommandController.php.

Referenced by CommandController\injectObjectManager().

$output
protected

Definition at line 84 of file CommandController.php.

$reflectionService
protected

Definition at line 74 of file CommandController.php.

Referenced by CommandController\injectReflectionService().

$request
protected

Definition at line 39 of file CommandController.php.

Referenced by CommandController\processRequest().

$requestAdminPermissions = false
protected

Definition at line 64 of file CommandController.php.

$response
protected

Definition at line 44 of file CommandController.php.

Referenced by CommandController\processRequest().

$userAuthentication
protected

Definition at line 69 of file CommandController.php.