Class VersionCommand
Print out the version of CakePHP in use.
- Cake\Console\Command uses Cake\ORM\Locator\LocatorAwareTrait , Cake\Log\LogTrait , Cake\Datasource\ModelAwareTrait
-
Cake\Command\VersionCommand
Inherited Constants
Inherited Properties
Method Summary
-
execute() public
Print out the version of CakePHP in use.
Method Detail
execute() public ¶
execute( Cake\Console\Arguments $args , Cake\Console\ConsoleIo $io )
Print out the version of CakePHP in use.
Parameters
-
Cake\Console\Arguments$args - The command arguments.
-
Cake\Console\ConsoleIo$io - The console io
Returns
Overrides
Methods inherited from Cake\Console\Command
__construct() public ¶
__construct( )
Constructor
By default CakePHP will construct command objects when building the CommandCollection for your application.
abort() public ¶
abort( integer $code = self::CODE_ERROR )
Halt the the current process with a StopException.
Parameters
- integer $code optional self::CODE_ERROR
- The exit code to use.
Throws
buildOptionParser() protected ¶
buildOptionParser( Cake\Console\ConsoleOptionParser $parser )
Hook method for defining this command's option parser.
Parameters
-
Cake\Console\ConsoleOptionParser$parser - The parser to be defined
Returns
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
executeCommand() public ¶
executeCommand( string|Cake\Console\Command $command , array $args = [] , Cake\Console\ConsoleIo $io = null )
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 null - The ConsoleIo instance to use for the executed command.
Returns
The exit code or null for success of the command.
getOptionParser() public ¶
getOptionParser( )
Get the option parser.
You can override buildOptionParser() to define your options & arguments.
Returns
Throws
When the parser is invalid
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.
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
Exit code or null for success.
setName() public ¶
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.
Parameters
- string $name
- The name the command uses in the collection.
Returns
$this
Throws
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
Methods used from Cake\ORM\Locator\LocatorAwareTrait
setTableLocator() public ¶
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Sets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator - LocatorInterface instance.
Returns
$this
tableLocator() public deprecated ¶
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )
Sets the table locator. If no parameters are passed, it will return the currently used locator.
Deprecated
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator optional null - LocatorInterface instance.
Returns
Methods used from Cake\Log\LogTrait
log() public ¶
log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Parameters
- mixed $msg
- Log message.
- integer|string $level optional LogLevel::ERROR
- Error level.
- string|array $context optional []
- Additional log data relevant to this message.
Returns
Success of log write.
Methods used from Cake\Datasource\ModelAwareTrait
_setModelClass() protected ¶
_setModelClass( string $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.
loadModel() public ¶
loadModel( string|null $modelClass = null , string|null $modelType = null )
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 null
Name of model class to load. Defaults to $this->modelClass. The name can be an alias like
'Post'or FQCN likeApp\Model\Table\PostsTable::class.- string|null $modelType optional null
- The type of repository to load. Defaults to the modelType() value.
Returns
Throws
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
InvalidArgumentException
When using a type that has not been registered.
UnexpectedValueException
If no model type has been defined
modelFactory() public ¶
modelFactory( string $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 deprecated ¶
modelType( string|null $modelType = null )
Set or get the model type to be used by this class
Deprecated
Parameters
- string|null $modelType optional null
- The model type or null to retrieve the current
Returns
setModelType() public ¶
setModelType( string $modelType )
Set the model type to be used by this class
Parameters
- string $modelType
- The model type
Returns
$this