UserFrosting API

MigrateCommand extends BaseCommand Uses ConfirmableTrait

migrate Bakery Command Perform database migration.

Tags
author

Louis Charette

Table of Contents

$io SymfonyStyle
$ci ContainerInterface
configure() {@inheritdoc} mixed
execute() {@inheritdoc} mixed
setupMigrator() Setup migrator and the shared options between other command. Migrator
displayNotes() Display migrator notes. mixed
confirmToProceed() Confirm before proceeding with the action. bool
getDefaultConfirmCallback() Get the default confirmation callback. Closure
initialize() {@inheritdoc} mixed
setContainer() Setup the global container object. void
isProduction() Return if the app is in production mode. bool

Properties

Methods

configure()

{@inheritdoc}

protected configure( ) : mixed
Return values
mixed

execute()

{@inheritdoc}

protected execute( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

setupMigrator()

Setup migrator and the shared options between other command.

protected setupMigrator( $input : InputInterface ) : Migrator
Parameters
$input : InputInterface
Return values
Migrator

The migrator instance

displayNotes()

Display migrator notes.

protected displayNotes( $migrator : Migrator ) : mixed
Parameters
$migrator : Migrator
Return values
mixed

confirmToProceed()

Confirm before proceeding with the action.

public confirmToProceed( [ $force : bool = false ] [, $warning : string = 'Application In Production Mode!' ] [, $callback : Closure|bool|null = null ] ) : bool

This method only asks for confirmation in production.

Parameters
$force : bool = false
$warning : string = 'Application In Production Mode!'
$callback : Closure|bool|null = null
Return values
bool

getDefaultConfirmCallback()

Get the default confirmation callback.

protected getDefaultConfirmCallback( ) : Closure
Return values
Closure

initialize()

{@inheritdoc}

protected initialize( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

setContainer()

Setup the global container object.

public setContainer( $ci : ContainerInterface ) : void
Parameters
$ci : ContainerInterface

isProduction()

Return if the app is in production mode.

protected isProduction( ) : bool

@return bool True/False if the app is in production mode

Return values
bool

Search results