built-in Server command
int
1
int
0
string
'localhost'
int
8765
string
document root
string
server host
string
ini path
(callable|\Cake\Datasource\Locator\LocatorInterface)[]
A list of overridden model factory functions.
string
The model type to use.
int
listen port
\Cake\ORM\Locator\LocatorInterface|null
Table locator instance
string|null
This object's primary model class name. Should be a plural form.
string
The name of this command.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
__construct()
Constructor
By default CakePHP will construct command objects when building the CommandCollection for your application.
_setModelClass(string $name)
Set the modelClass property based on conventions.
If the property is already set it will not be overwritten
string
$name Class name.
abort(int $code)
Halt the the current process with a StopException.
int
$code optional The exit code to use.
Cake\Console\Exception\StopException
buildOptionParser(\Cake\Console\ConsoleOptionParser $parser)
Hook method for defining this command's option parser.
\Cake\Console\ConsoleOptionParser
$parser The option parser to update
\Cake\Console\ConsoleOptionParser
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'
.
string
displayHelp(\Cake\Console\ConsoleOptionParser $parser, \Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)
Output help content
\Cake\Console\ConsoleOptionParser
$parser The option parser.
\Cake\Console\Arguments
$args The command arguments.
\Cake\Console\ConsoleIo
$io The console io
execute(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)
Execute.
\Cake\Console\Arguments
$args The command arguments.
\Cake\Console\ConsoleIo
$io The console io
int|null
The exit code or null for success
executeCommand(mixed $command, array $args, ?\Cake\Console\ConsoleIo $io)
Execute another command with the provided set of arguments.
string|\Cake\Console\CommandInterface
$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.
int|null
The exit code or null for success of the command.
getModelType()
Get the model type to be used by this class
string
getName()
Get the command name.
string
getOptionParser()
Get the option parser.
You can override buildOptionParser() to define your options & arguments.
\Cake\Console\ConsoleOptionParser
RuntimeException
getRootName()
Get the root command name.
string
getTableLocator()
Gets the table locator.
\Cake\ORM\Locator\LocatorInterface
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(?string $modelClass, ?string $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.
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
The model instance created.
Cake\Datasource\Exception\MissingModelException
UnexpectedValueException
log(string $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string
$message Log message.
int|string
$level optional Error level.
string|array
$context optional Additional log data relevant to this message.
bool
Success of log write.
modelFactory(string $type, mixed $factory)
Override a existing callable to generate repositories of a given type.
string
$type The name of the repository type the factory function is for.
callable|\Cake\Datasource\Locator\LocatorInterface
$factory The factory function used to create instances.
run(array $argv, \Cake\Console\ConsoleIo $io)
Run the command.
array
$argv Arguments from the CLI environment.
\Cake\Console\ConsoleIo
$io The console io
int|null
Exit code or null for success.
setModelType(string $modelType)
Set the model type to be used by this class
string
$modelType The model type
$this
setName(string $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.
string
$name The name the command uses in the collection.
$this
InvalidArgumentException
setOutputLevel(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)
Set the output level based on the Arguments.
\Cake\Console\Arguments
$args The command arguments.
\Cake\Console\ConsoleIo
$io The console io
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)
Sets the table locator.
\Cake\ORM\Locator\LocatorInterface
$tableLocator LocatorInterface instance.
$this
startup(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)
Starts up the Command and displays the welcome message.
Allows for checking and configuring prior to command or main execution
\Cake\Console\Arguments
$args The command arguments.
\Cake\Console\ConsoleIo
$io The console io
document root
string
server host
string
ini path
string
A list of overridden model factory functions.
(callable|\Cake\Datasource\Locator\LocatorInterface)[]
The model type to use.
string
listen port
int
Table locator instance
\Cake\ORM\Locator\LocatorInterface|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.1/class-Cake.Command.ServerCommand.html