TYPO3\CMS\Extbase\Command\HelpCommandController Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Command\HelpCommandController:

Public Member Functions
	injectCommandManager (\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager)
	helpStubCommand ()
	helpCommand ($commandIdentifier=null)
	errorCommand (\TYPO3\CMS\Extbase\Mvc\Exception\CommandException $exception)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\CommandController
	__construct ()
	injectObjectManager (ObjectManagerInterface $objectManager)
	injectReflectionService (ReflectionService $reflectionService)
bool	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
	displayHelpIndex ()
	displayHelpForCommand (\TYPO3\CMS\Extbase\Mvc\Cli\Command $command)
	buildCommandsIndex ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\CommandController
string	resolveCommandMethodName ()
	initializeCommandMethodArguments ()
	mapRequestArgumentsToControllerArguments ()
	initializeBackendAuthentication ()
	forward ($commandName, $controllerObjectName=null, array $arguments=[])
	callCommandMethod ()
	output ($text, array $arguments=[])
	outputLine ($text='', array $arguments=[])
	outputFormatted ($text='', array $arguments=[], $leftPadding=0)
	quit ($exitCode=0)
	sendAndExit ($exitCode=0)
BackendUserAuthentication null	getBackendUserAuthentication ()

Protected Attributes
TYPO3 CMS Extbase Mvc Cli CommandManager	$commandManager
array	$commandsByExtensionsAndControllers = array( )
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\CommandController
Request	$request
Response	$response
Arguments	$arguments
string	$commandMethodName = ''
bool	$requestAdminPermissions = false
ReflectionService	$reflectionService
ObjectManagerInterface	$objectManager
ConsoleOutput	$output

Detailed Description

A Command Controller which provides help for available commands

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0.

Definition at line 22 of file HelpCommandController.php.

Member Function Documentation

buildCommandsIndex()

TYPO3\CMS\Extbase\Command\HelpCommandController::buildCommandsIndex ( )

protected

Builds an index of available commands. For each of them a Command object is added to the commands array of this class.

Definition at line 204 of file HelpCommandController.php.

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpIndex().

displayHelpForCommand()

TYPO3\CMS\Extbase\Command\HelpCommandController::displayHelpForCommand ( \TYPO3\CMS\Extbase\Mvc\Cli\Command  $command )

protected

Render help text for a single command

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\Command

$command

Definition at line 112 of file HelpCommandController.php.

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

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\helpCommand().

displayHelpIndex()

TYPO3\CMS\Extbase\Command\HelpCommandController::displayHelpIndex ( )

protected

Builds an index of all commands that are available

Definition at line 83 of file HelpCommandController.php.

References TYPO3\CMS\Extbase\Command\HelpCommandController\buildCommandsIndex(), TYPO3\CMS\Extbase\Mvc\Controller\CommandController\output(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputLine().

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\helpCommand().

errorCommand()

TYPO3\CMS\Extbase\Command\HelpCommandController::errorCommand

(

\TYPO3\CMS\Extbase\Mvc\Exception\CommandException

$exception

)

Displays an error message

Parameters

\TYPO3\CMS\Extbase\Mvc\Exception\CommandException

$exception

Definition at line 186 of file HelpCommandController.php.

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

helpCommand()

TYPO3\CMS\Extbase\Command\HelpCommandController::helpCommand

(

$commandIdentifier = null

)

Display help for a command

The help command displays help for a given command: ./typo3/sysext/core/bin/typo3 extbase:help <command identifier>

Parameters

string

$commandIdentifier

‪Identifier of a command for more details

Definition at line 65 of file HelpCommandController.php.

References TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpForCommand(), TYPO3\CMS\Extbase\Command\HelpCommandController\displayHelpIndex(), and TYPO3\CMS\Extbase\Mvc\Controller\CommandController\outputLine().

helpStubCommand()

TYPO3\CMS\Extbase\Command\HelpCommandController::helpStubCommand

(

)

Displays a short, general help message

This only outputs the Extbase version number, context and some hint about how to get more help about commands.

Definition at line 48 of file HelpCommandController.php.

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

injectCommandManager()

TYPO3\CMS\Extbase\Command\HelpCommandController::injectCommandManager

(

\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager

$commandManager

)

Parameters

\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager

$commandManager

Definition at line 35 of file HelpCommandController.php.

References TYPO3\CMS\Extbase\Command\HelpCommandController\$commandManager.

Member Data Documentation

$commandManager

TYPO3 CMS Extbase Mvc Cli CommandManager TYPO3\CMS\Extbase\Command\HelpCommandController::$commandManager

protected

Definition at line 26 of file HelpCommandController.php.

Referenced by TYPO3\CMS\Extbase\Command\HelpCommandController\injectCommandManager().

$commandsByExtensionsAndControllers

array TYPO3\CMS\Extbase\Command\HelpCommandController::$commandsByExtensionsAndControllers = array( )

protected

Definition at line 30 of file HelpCommandController.php.