TYPO3\CMS\Extbase\Command\HelpCommandController Class Reference

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

Public Member Functions
	helpStubCommand ()
	helpCommand ($commandIdentifier=NULL)
	errorCommand (\TYPO3\CMS\Extbase\Mvc\Exception\CommandException $exception)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\CommandController
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	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
	resolveCommandMethodName ()
	initializeCommandMethodArguments ()
	mapRequestArgumentsToControllerArguments ()
	forward ($commandName, $controllerObjectName=NULL, array $arguments=array())
	callCommandMethod ()
	ensureAdminRoleIfRequested ()
	restoreUserRole ($originalRole)
	output ($text, array $arguments=array())
	outputLine ($text='', array $arguments=array())
	quit ($exitCode=0)
	sendAndExit ($exitCode=0)

Protected Attributes
	$commandManager
	$commandsByExtensionsAndControllers = array()
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\CommandController
	$request
	$response
	$arguments
	$commandMethodName = ''
	$requestAdminPermissions = FALSE
	$userAuthentication
	$reflectionService
	$objectManager

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\CommandController
const	MAXIMUM_LINE_LENGTH = 79

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! A Command Controller which provides help for available commands

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

Definition at line 21 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.

Returns

void

Definition at line 199 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

Returns

void

Definition at line 106 of file HelpCommandController.php.

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

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

displayHelpIndex()

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

protected

Returns

void

Definition at line 77 of file HelpCommandController.php.

References TYPO3\CMS\Extbase\Command\HelpCommandController\buildCommandsIndex(), 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

Definition at line 180 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: ./cli_dispatch.phpsh extbase help <command identifier>="">

Parameters

string

$commandIdentifier

Identifier of a command for more details

Returns

void

Definition at line 60 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.

Returns

void

Definition at line 43 of file HelpCommandController.php.

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

Member Data Documentation

$commandManager

TYPO3\CMS\Extbase\Command\HelpCommandController::$commandManager

protected

Definition at line 27 of file HelpCommandController.php.

$commandsByExtensionsAndControllers

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

protected

Definition at line 32 of file HelpCommandController.php.