Provides interactive CLI tools for URL generation
int
1
Default error code
int
0
Default success code
array<callableCake\Datasource\Locator\LocatorInterface>
A list of overridden model factory functions.
string
The model type to use.
Cake\ORM\Locator\LocatorInterface|null
Table locator instance
string|null
This object's default table alias.
string|null
This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
string
The name of this command.
Constructor
Set the modelClass property based on conventions.
Split the CLI arguments into a hash.
Halt the the current process with a StopException.
Get the option parser.
Get the command name.
Output help content
Display all routes in an application
Execute another command with the provided set of arguments.
Convenience method to get a table instance.
Get the command description.
Get the model type to be used by this class
Get the command name.
Get the option parser.
Get the root command name.
Gets the table locator.
Hook method invoked by CakePHP when a command is about to be executed.
Loads and constructs repository objects required by this object
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Override a existing callable to generate repositories of a given type.
Run the command.
Set the model type to be used by this class
Set the name this command uses in the collection.
Set the output level based on the Arguments.
Sets the table locator.
__construct()
Constructor
By default CakePHP will construct command objects when building the CommandCollection for your application.
_setModelClass(string $name): void
Set the modelClass property based on conventions.
If the property is already set it will not be overwritten
string
$name Class name.
void
_splitArgs(array<string> $args): array<string|bool>
Split the CLI arguments into a hash.
array<string>
$args The arguments to split.
array<string|bool>
abort(int $code = self::CODE_ERROR): void
Halt the the current process with a StopException.
int
$code optional The exit code to use.
void
Cake\Console\Exception\StopException
buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser
Get the option parser.
Cake\Console\ConsoleOptionParser
$parser The option parser to update
Cake\Console\ConsoleOptionParser
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'
.
string
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
void
execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int|null
Display all routes in an application
Cake\Console\Arguments
$args The command arguments.
Cake\Console\ConsoleIo
$io The console io
int|null
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.
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.
int|null
fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table
Convenience method to get a table instance.
string|null
$alias optional The alias name you want to get. Should be in CamelCase format. If null
then the value of $defaultTable property is used.
array<string, mixed>
$options optional The options you want to build the table with. If a table has already been loaded the registry options will be ignored.
Cake\ORM\Table
Cake\Core\Exception\CakeException
getDescription(): string
Get the command description.
string
getModelType(): string
Get the model type to be used by this class
string
getName(): string
Get the command name.
string
getOptionParser(): Cake\Console\ConsoleOptionParser
Get the option parser.
You can override buildOptionParser() to define your options & arguments.
Cake\Console\ConsoleOptionParser
RuntimeException
getRootName(): string
Get the root command name.
string
getTableLocator(): Cake\ORM\Locator\LocatorInterface
Gets the table locator.
Cake\ORM\Locator\LocatorInterface
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.
void
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 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 getModelType() value.
Cake\Datasource\RepositoryInterface
Cake\Datasource\Exception\MissingModelException
UnexpectedValueException
log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string
$message Log message.
string|int
$level optional Error level.
array|string
$context optional Additional log data relevant to this message.
bool
modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void
Override a existing callable to generate repositories of a given type.
string
$type The name of the repository type the factory function is for.
Cake\Datasource\Locator\LocatorInterface|callable
$factory The factory function used to create instances.
void
run(array $argv, Cake\Console\ConsoleIo $io): int|null
Run the command.
array
$argv Cake\Console\ConsoleIo
$io int|null
setModelType(string $modelType): $this
Set the model type to be used by this class
string
$modelType The model type
$this
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 $this
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
void
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this
Sets the table locator.
Cake\ORM\Locator\LocatorInterface
$tableLocator LocatorInterface instance.
$this
A list of overridden model factory functions.
array<callableCake\Datasource\Locator\LocatorInterface>
The model type to use.
string
Table locator instance
Cake\ORM\Locator\LocatorInterface|null
This object's default table alias.
string|null
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 empty string to not use auto-loading on this object. Null auto-detects based on controller name.
string|null
The name of this command.
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.Command.RoutesGenerateCommand.html