Class HelpCommand

Print out command list

Namespace: Cake\Command

Constants summary

  • int
    CODE_ERROR
    1
  • int
    CODE_SUCCESS
    0

Properties summary

  • $_modelFactories protected
    array

    A list of overridden model factory functions.

  • $_modelType protected
    string

    The model type to use.

  • $_tableLocator protected
    \Cake\ORM\Locator\LocatorInterface

    Table locator instance

  • $commands protected
    \Cake\Console\CommandCollection

    The command collection to get help on.

  • $modelClass public
    string|false|null

    This object's primary model class name. Should be a plural form.

  • $name protected
    string

    The name of this command.

Method Summary

Method Detail

__construct() public 

__construct()

Constructor

By default CakePHP will construct command objects when building the CommandCollection for your application.

_setModelClass() protected 

_setModelClass(mixed $name)

Set the modelClass and modelKey properties based on conventions.

If the properties are already set they will not be overwritten

Parameters

string $name

Class name.

abort() public 

abort(mixed $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(mixed $io, mixed $commands)

Output text.

Parameters

\Cake\Console\ConsoleIo $io

The console io

\ArrayIterator $commands

The command collection to output.

asXml() protected 

asXml(mixed $io, mixed $commands)

Output as XML

Parameters

\Cake\Console\ConsoleIo $io

The console io

\ArrayIterator $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\Command $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.

findPrefixedName() protected 

findPrefixedName(array $names)

Parameters

string[] $names

Names

Returns

string|null

getModelType() public 

getModelType()

Get the model type to be used by this class

Returns

string

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

getShortestName() protected 

getShortestName(array $names)

Parameters

string[] $names

Names

Returns

string

getTableLocator() public 

getTableLocator()

Gets the table locator.

Returns

\Cake\ORM\Locator\LocatorInterface

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.

loadModel() public 

loadModel(mixed $modelClass, mixed $modelType)

Loads and constructs repository objects required by this object

Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.

If a repository provider does not return an object a MissingModelException will be thrown.

Parameters

string|null $modelClass optional

Name of model class to load. Defaults to $this->modelClass. The name can be an alias like 'Post' or FQCN like App\Model\Table\PostsTable::class.

string|null $modelType optional

The type of repository to load. Defaults to the modelType() value.

Returns

\Cake\Datasource\RepositoryInterface

The model instance created.

Throws

Cake\Datasource\Exception\MissingModelException
If the model class cannot be found.
InvalidArgumentException
When using a type that has not been registered.
UnexpectedValueException
If no model type has been defined

log() public 

log(mixed $message, mixed $level, mixed $context)

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

mixed $message

Log message.

int|string $level optional

Error level.

string|array $context optional

Additional log data relevant to this message.

Returns

bool

Success of log write.

modelFactory() public 

modelFactory(mixed $type, callable $factory)

Override a existing callable to generate repositories of a given type.

Parameters

string $type

The name of the repository type the factory function is for.

callable $factory

The factory function used to create instances.

modelType() public 

modelType(mixed $modelType)

Set or get the model type to be used by this class

Parameters

string|null $modelType optional

The model type or null to retrieve the current

Returns

string|$this

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.

setModelType() public 

setModelType(mixed $modelType)

Set the model type to be used by this class

Parameters

string $modelType

The model type

Returns

$this

setName() public 

setName(mixed $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

setTableLocator() public 

setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)

Sets the table locator.

Parameters

\Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

tableLocator() public 

tableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)

Sets the table locator.

If no parameters are passed, it will return the currently used locator.

Parameters

\Cake\ORM\Locator\LocatorInterface|null $tableLocator optional

LocatorInterface instance.

Returns

\Cake\ORM\Locator\LocatorInterface

Property Detail

$_modelFactories protected

A list of overridden model factory functions.

Type

array

$_modelType protected

The model type to use.

Type

string

$_tableLocator protected

Table locator instance

Type

\Cake\ORM\Locator\LocatorInterface

$commands protected

The command collection to get help on.

Type

\Cake\Console\CommandCollection

$modelClass public

This object's primary model class name. Should be a plural form.

CakePHP will not inflect the name.

Example: For an object named 'Comments', the modelClass would be 'Comments'. Plugin classes should use Plugin.Comments style names to correctly load models from the correct plugin.

Use false to not use auto-loading on this object. Null auto-detects based on controller name.

Type

string|false|null

$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/3.9/class-Cake.Command.HelpCommand.html