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

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 CommandController
 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

 displayHelpIndex ()
 
 displayHelpForCommand (\TYPO3\CMS\Extbase\Mvc\Cli\Command $command)
 
 buildCommandsIndex ()
 
- Protected Member Functions inherited from CommandController
 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

 $commandManager
 
 $commandsByExtensionsAndControllers = array()
 
- Protected Attributes inherited from CommandController
 $request
 
 $response
 
 $arguments
 
 $commandMethodName = ''
 
 $requestAdminPermissions = false
 
 $userAuthentication
 
 $reflectionService
 
 $objectManager
 
 $output
 

Detailed Description

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 22 of file HelpCommandController.php.

Member Function Documentation

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 212 of file HelpCommandController.php.

Referenced by HelpCommandController\displayHelpIndex().

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 117 of file HelpCommandController.php.

References CommandController\output(), and CommandController\outputLine().

Referenced by HelpCommandController\helpCommand().

displayHelpIndex ( )
protected
errorCommand ( \TYPO3\CMS\Extbase\Mvc\Exception\CommandException  $exception)

Displays an error message

Definition at line 192 of file HelpCommandController.php.

References CommandController\outputLine().

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$commandIdentifierIdentifier of a command for more details

Definition at line 69 of file HelpCommandController.php.

References HelpCommandController\displayHelpForCommand(), HelpCommandController\displayHelpIndex(), and CommandController\outputLine().

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 51 of file HelpCommandController.php.

References CommandController\outputLine().

injectCommandManager ( \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager  $commandManager)
Parameters
\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager$commandManager

Definition at line 37 of file HelpCommandController.php.

References HelpCommandController\$commandManager.

Member Data Documentation

$commandManager
protected
$commandsByExtensionsAndControllers = array()
protected

Definition at line 32 of file HelpCommandController.php.