W3cubDocs

/CakePHP 4.4

Interface CommandInterface

Describe the interface between a command and the surrounding console libraries.

Namespace: Cake\Console

Constants

  • int
    CODE_ERROR 
    1

    Default error code

  • int
    CODE_SUCCESS 
    0

    Default success code

Method Summary

  • run() public

    Run the command.

  • setName() public

    Set the name this command uses in the collection.

Method Detail

run() public 

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

Run the command.

Parameters

array $argv

Arguments from the CLI environment.

Cake\Console\ConsoleIo $io

The console io

Returns

int|null

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

The name the command uses in the collection.

Returns

$this

Throws

InvalidArgumentException

© 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/interface-Cake.Console.CommandInterface.html