W3cubDocs

/CakePHP 4.1

Class HelpCommand

Print out command list

Namespace: Cake\Console\Command

Constants summary

  • int
    CODE_ERROR
    1
  • int
    CODE_SUCCESS
    0

Properties summary

  • $commands protected
    \Cake\Console\CommandCollection

    The command collection to get help on.

  • $name protected
    string

    The name of this command.

Method Summary

Method Detail

abort() public 

abort(int $code)

Halt the the current process with a StopException.

Parameters

int $code optional

The exit code to use.

Throws

Cake\Console\Exception\StopException

asText() protected 

asText(\Cake\Console\ConsoleIo $io, iterable $commands)

Output text.

Parameters

\Cake\Console\ConsoleIo $io

The console io

iterable $commands

The command collection to output.

asXml() protected 

asXml(\Cake\Console\ConsoleIo $io, iterable $commands)

Output as XML

Parameters

\Cake\Console\ConsoleIo $io

The console io

iterable $commands

The command collection to output

buildOptionParser() protected 

buildOptionParser(\Cake\Console\ConsoleOptionParser $parser)

Gets the option parser instance and configures it.

Parameters

\Cake\Console\ConsoleOptionParser $parser

The parser to build

Returns

\Cake\Console\ConsoleOptionParser

defaultName() public static 

defaultName()

Get the command name.

Returns the command name based on class name. For e.g. for a command with class name UpdateTableCommand the default name returned would be 'update_table'.

Returns

string

displayHelp() protected 

displayHelp(\Cake\Console\ConsoleOptionParser $parser, \Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

Output help content

Parameters

\Cake\Console\ConsoleOptionParser $parser

The option parser.

\Cake\Console\Arguments $args

The command arguments.

\Cake\Console\ConsoleIo $io

The console io

execute() public 

execute(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

Main function Prints out the list of commands.

Parameters

\Cake\Console\Arguments $args

The command arguments.

\Cake\Console\ConsoleIo $io

The console io

Returns

int

executeCommand() public 

executeCommand(mixed $command, array $args, ?\Cake\Console\ConsoleIo $io)

Execute another command with the provided set of arguments.

Parameters

string|\Cake\Console\CommandInterface $command

The command class name or command instance.

array $args optional

The arguments to invoke the command with.

\Cake\Console\ConsoleIo $io optional

The ConsoleIo instance to use for the executed command.

Returns

int|null

The exit code or null for success of the command.

getName() public 

getName()

Get the command name.

Returns

string

getOptionParser() public 

getOptionParser()

Get the option parser.

You can override buildOptionParser() to define your options & arguments.

Returns

\Cake\Console\ConsoleOptionParser

Throws

RuntimeException
When the parser is invalid

getRootName() public 

getRootName()

Get the root command name.

Returns

string

getShortestName() protected 

getShortestName(array $names)

Parameters

string[] $names

Names

Returns

string

initialize() public 

initialize()

Hook method invoked by CakePHP when a command is about to be executed.

Override this method and implement expensive/important setup steps that should not run on every command run. This method will be called before the options and arguments are validated and processed.

outputPaths() protected 

outputPaths(\Cake\Console\ConsoleIo $io)

Output relevant paths if defined

Parameters

\Cake\Console\ConsoleIo $io

IO object.

run() public 

run(array $argv, \Cake\Console\ConsoleIo $io)

Run the command.

Parameters

array $argv

Arguments from the CLI environment.

\Cake\Console\ConsoleIo $io

The console io

Returns

int|null

Exit code or null for success.

setCommandCollection() public 

setCommandCollection(\Cake\Console\CommandCollection $commands)

Set the command collection being used.

Parameters

\Cake\Console\CommandCollection $commands

The commands to use.

setName() public 

setName(string $name)

Set the name this command uses in the collection.

Generally invoked by the CommandCollection when the command is added. Required to have at least one space in the name so that the root command can be calculated.

Parameters

string $name

The name the command uses in the collection.

Returns

$this

Throws

InvalidArgumentException

setOutputLevel() protected 

setOutputLevel(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

Set the output level based on the Arguments.

Parameters

\Cake\Console\Arguments $args

The command arguments.

\Cake\Console\ConsoleIo $io

The console io

Property Detail

$commands protected

The command collection to get help on.

Type

\Cake\Console\CommandCollection

$name protected

The name of this command.

Type

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Console.Command.HelpCommand.html