CODE_ERROR
CODE_ERROR = 1 : integer
Default error code
Print out command list
$modelClass : string
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.
$_tableLocator : \Cake\ORM\Locator\LocatorInterface
Table locator instance
$commands : \Cake\Console\CommandCollection
The command collection to get help on.
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.
| string | $name | The name the command uses in the collection. |
getOptionParser() : \Cake\Console\ConsoleOptionParser
Get the option parser.
You can override buildOptionParser() to define your options & arguments.
When the parser is invalid
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.
run(array $argv, \Cake\Console\ConsoleIo $io) : integer|null
Run the command.
| array | $argv | Arguments from the CLI environment. |
| \Cake\Console\ConsoleIo | $io | The console io |
Exit code or null for success.
execute(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io) : integer
Main function Prints out the list of commands.
| \Cake\Console\Arguments | $args | The command arguments. |
| \Cake\Console\ConsoleIo | $io | The console io |
tableLocator(\Cake\ORM\Locator\LocatorInterface|null $tableLocator = null) : \Cake\ORM\Locator\LocatorInterface
Sets the table locator.
If no parameters are passed, it will return the currently used locator.
| \Cake\ORM\Locator\LocatorInterface|null | $tableLocator | LocatorInterface instance. |
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator) : $this
Sets the table locator.
| \Cake\ORM\Locator\LocatorInterface | $tableLocator | LocatorInterface instance. |
getTableLocator() : \Cake\ORM\Locator\LocatorInterface
Gets the table locator.
log(mixed $msg, integer|string $level = \Psr\Log\LogLevel::ERROR, string|array $context = array()) : boolean
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
| mixed | $msg | Log message. |
| integer|string | $level | Error level. |
| string|array | $context | Additional log data relevant to this message. |
Success of log write.
loadModel(string|null $modelClass = null, string|null $modelType = null) : \Cake\Datasource\RepositoryInterface
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.
| string|null | $modelClass | Name of model class to load. Defaults to $this->modelClass |
| string|null | $modelType | The type of repository to load. Defaults to the modelType() value. |
If the model class cannot be found.
When using a type that has not been registered.
If no model type has been defined
The model instance created.
setCommandCollection(\Cake\Console\CommandCollection $commands) : void
Set the command collection being used.
| \Cake\Console\CommandCollection | $commands | The commands to use. |
buildOptionParser(\Cake\Console\ConsoleOptionParser $parser) : \Cake\Console\ConsoleOptionParser
Gets the option parser instance and configures it.
| \Cake\Console\ConsoleOptionParser | $parser | The parser to build |
displayHelp(\Cake\Console\ConsoleOptionParser $parser, \Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io) : void
Output help content
| \Cake\Console\ConsoleOptionParser | $parser | The option parser. |
| \Cake\Console\Arguments | $args | The command arguments. |
| \Cake\Console\ConsoleIo | $io | The console io |
setOutputLevel(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io) : void
Set the output level based on the Arguments.
| \Cake\Console\Arguments | $args | The command arguments. |
| \Cake\Console\ConsoleIo | $io | The console io |
asText(\Cake\Console\ConsoleIo $io, \ArrayIterator $commands) : void
Output text.
| \Cake\Console\ConsoleIo | $io | The console io |
| \ArrayIterator | $commands | The command collection to output. |
asXml(\Cake\Console\ConsoleIo $io, \ArrayIterator $commands) : void
Output as XML
| \Cake\Console\ConsoleIo | $io | The console io |
| \ArrayIterator | $commands | The command collection to output |