W3cubDocs

/CakePHP 4.4

Class HelpCommand

Print out command list

Namespace: Cake\Console\Command

Constants

  • int
    CODE_ERROR 
    1

    Default error code

  • int
    CODE_SUCCESS 
    0

    Default success code

Property 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 = self::CODE_ERROR): void

Halt the the current process with a StopException.

Parameters

int $code optional

The exit code to use.

Returns

void

Throws

Cake\Console\Exception\StopException

asText() protected 

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

Output text.

Parameters

Cake\Console\ConsoleIo $io

The console io

iterable $commands

The command collection to output.

Returns

void

asXml() protected 

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

Output as XML

Parameters

Cake\Console\ConsoleIo $io

The console io

iterable $commands

The command collection to output

Returns

void

buildOptionParser() protected 

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

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(): string

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): void

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

Returns

void

execute() public 

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

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(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

Execute another command with the provided set of arguments.

If you are using a string command name, that command's dependencies will not be resolved with the application container. Instead you will need to pass the command as an object with all of its dependencies.

Parameters

Cake\Console\CommandInterface|string $command

The command class name or command instance.

array $args optional

The arguments to invoke the command with.

Cake\Console\ConsoleIo|null $io optional

The ConsoleIo instance to use for the executed command.

Returns

int|null

getDescription() public static 

getDescription(): string

Get the command description.

Returns

string

getName() public 

getName(): string

Get the command name.

Returns

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

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(): string

Get the root command name.

Returns

string

getShortestName() protected 

getShortestName(array<string> $names): string

Parameters

array<string> $names

Names

Returns

string

initialize() public 

initialize(): void

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.

Returns

void

outputPaths() protected 

outputPaths(Cake\Console\ConsoleIo $io): void

Output relevant paths if defined

Parameters

Cake\Console\ConsoleIo $io

IO object.

Returns

void

run() public 

run(array $argv, Cake\Console\ConsoleIo $io): int|null

Run the command.

Parameters

array $argv
Cake\Console\ConsoleIo $io

Returns

int|null

setCommandCollection() public 

setCommandCollection(Cake\Console\CommandCollection $commands): void

Set the command collection being used.

Parameters

Cake\Console\CommandCollection $commands

Returns

void

setName() public 

setName(string $name): $this

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

Returns

$this

setOutputLevel() protected 

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

Set the output level based on the Arguments.

Parameters

Cake\Console\Arguments $args

The command arguments.

Cake\Console\ConsoleIo $io

The console io

Returns

void

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.4/class-Cake.Console.Command.HelpCommand.html