Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • Command
  • HelpCommand
  • ListCommand
  • Overview
  • Namespace
  • Class

Class HelpCommand

HelpCommand displays the help for a given command.

Symfony\Component\Console\Command\Command
Extended by Symfony\Component\Console\Command\HelpCommand
Namespace: Symfony\Component\Console\Command
Author: Fabien Potencier fabien@symfony.com
Located at Command/HelpCommand.php
Methods summary
protected
# configure( )

Configures the current command.

Configures the current command.

Overrides

Symfony\Component\Console\Command\Command::configure()
public
# setCommand( Symfony\Component\Console\Command\Command $command )

Sets the command.

Sets the command.

Parameters

$command
The command to set
protected null|integer
# execute( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )

Executes the current command.

Executes the current command.

Parameters

$input
An InputInterface instance
$output
An OutputInterface instance

Returns

null|integer
null or 0 if everything went fine, or an error code

Throws

LogicException
When this abstract method is not implemented

Overrides

Symfony\Component\Console\Command\Command::execute()
Methods inherited from Symfony\Component\Console\Command\Command
__construct(), addArgument(), addOption(), addUsage(), asText(), asXml(), getAliases(), getApplication(), getDefinition(), getDescription(), getHelp(), getHelper(), getHelperSet(), getName(), getNativeDefinition(), getProcessedHelp(), getSynopsis(), getUsages(), ignoreValidationErrors(), initialize(), interact(), isEnabled(), mergeApplicationDefinition(), run(), setAliases(), setApplication(), setCode(), setDefinition(), setDescription(), setHelp(), setHelperSet(), setName(), setProcessTitle()
Peridot API documentation generated by ApiGen