TYPO3\CMS\Extbase\Mvc\Controller\CommandController Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\Controller\CommandController:

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)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)

Protected Member Functions
	resolveCommandMethodName ()
	initializeCommandMethodArguments ()
	forward ($commandName, $controllerObjectName=null, array $arguments=[])
	ensureAdminRoleIfRequested ()
	restoreUserRole ($originalRole)
	output ($text, array $arguments=[])
	outputLine ($text='', array $arguments=[])
	outputFormatted ($text='', array $arguments=[], $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\Controller\CommandController::canProcessRequest

(

\TYPO3\CMS\Extbase\Mvc\RequestInterface

$request

)

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

Parameters

\TYPO3\CMS\Extbase\Mvc\RequestInterface

$request

The current request

Returns

bool TRUE if this request type is supported, otherwise FALSE

Implements TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface.

Definition at line 112 of file CommandController.php.

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

ensureAdminRoleIfRequested()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\forward().

forward()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::forward (   $commandName,   $controllerObjectName = null, array  $arguments = []  )

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 TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$arguments, TYPO3\CMS\Extbase\Mvc\Controller\CommandController\ensureAdminRoleIfRequested(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\restoreUserRole().

initializeCommandMethodArguments()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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

Definition at line 169 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output().

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

injectObjectManager()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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, TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$objectManager, and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output().

injectReflectionService()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::injectReflectionService

(

\TYPO3\CMS\Extbase\Reflection\ReflectionService

$reflectionService

)

Parameters

\TYPO3\CMS\Extbase\Reflection\ReflectionService

$reflectionService

Definition at line 101 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$reflectionService.

output()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::output (   $text, array  $arguments = []  )

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	$text	Text to output
array	$arguments	Optional arguments to use for sprintf

Returns

void

Definition at line 303 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$arguments.

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpForCommand(), TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpIndex(), TYPO3\CMS\Extensionmanager\Command\ExtensionCommandController\dumpClassLoadingInformationCommand(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\initializeCommandMethodArguments(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\injectObjectManager(), TYPO3\CMS\Lang\Command\LanguageCommandController\injectRegistryService(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputFormatted(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputLine().

outputFormatted()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::outputFormatted (   $text = '', array  $arguments = [],   $leftPadding = 0  )

protected

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

Parameters

string	$text	Text to output
array	$arguments	Optional arguments to use for sprintf
int	$leftPadding	The number of spaces to use for indentation

Returns

void

See also

outputLine()

Definition at line 331 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$arguments, and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output().

outputLine()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::outputLine (   $text = '', array  $arguments = []  )

protected

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

Parameters

string	$text	Text to output
array	$arguments	Optional arguments to use for sprintf

Returns

void

See also

output()

Definition at line 316 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$arguments, and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output().

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpForCommand(), TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpIndex(), TYPO3\CMS\Extbase\Command\HelpCommandController\errorCommand(), TYPO3\CMS\Extbase\Command\HelpCommandController\helpCommand(), TYPO3\CMS\Extbase\Command\HelpCommandController\helpStubCommand(), and TYPO3\CMS\Lang\Command\LanguageCommandController\injectRegistryService().

processRequest()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::processRequest	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Processes a command line request.

Parameters

RequestInterface	$request	The request object
ResponseInterface	$response	The response, modified by this handler

Returns

void

Exceptions

UnsupportedRequestTypeException

if the controller doesn't support the current request type

Definition at line 126 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$request, TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$response, TYPO3\CMS\Extbase\Mvc\Controller\CommandController\canProcessRequest(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\initializeCommandMethodArguments(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\resolveCommandMethodName().

quit()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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

$exitCode

Exit code to return on exit

Exceptions

StopActionException

Returns

void

Definition at line 344 of file CommandController.php.

Referenced by TYPO3\CMS\Extensionmanager\Command\ExtensionCommandController\dumpClassLoadingInformationCommand().

resolveCommandMethodName()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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

Definition at line 152 of file CommandController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\CommandController\$commandMethodName.

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

restoreUserRole()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::restoreUserRole (   $originalRole )

protected

Restores the original user role

Parameters

NULL | int

$originalRole

Definition at line 287 of file CommandController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\forward().

sendAndExit()

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::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

$exitCode

Exit code to return on exit

Returns

void

Definition at line 357 of file CommandController.php.

Member Data Documentation

$arguments

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$arguments

protected

Definition at line 49 of file CommandController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\forward(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputFormatted(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputLine().

$commandMethodName

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$commandMethodName = ''

protected

Definition at line 56 of file CommandController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\resolveCommandMethodName().

$objectManager

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$objectManager

protected

Definition at line 79 of file CommandController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\injectObjectManager().

$output

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$output

protected

Definition at line 84 of file CommandController.php.

$reflectionService

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$reflectionService

protected

Definition at line 74 of file CommandController.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\CommandController\injectReflectionService().

$request

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$request

protected

Definition at line 39 of file CommandController.php.

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

$requestAdminPermissions

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$requestAdminPermissions = false

protected

Definition at line 64 of file CommandController.php.

$response

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$response

protected

Definition at line 44 of file CommandController.php.

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

$userAuthentication

TYPO3\CMS\Extbase\Mvc\Controller\CommandController::$userAuthentication

protected

Definition at line 69 of file CommandController.php.