1. class
  2. Windwalker
  3. Core
  4. Migration
  5. Model
  6. MigrationsModel

MigrationsModel

class MigrationsModel extends ModelRepository (View source)

The MigrationsModel class.

Traits

DatabaseModelTrait
The DatabaseModelTrait class.
CliOutputModelTrait
The CliOutputModelTrait class.
BootableTrait
The BootableTrait class.
SingletonTrait
The MultiSingletonTrait class.

Methods

static SingletonTrait
getInstance(array $args)

getInstance

from SingletonTrait
static mixed
setInstance(object $instance)

setInstance

from SingletonTrait
__construct(Structure|array $config = null, Structure $state = null, mixed $source = null)

Instantiate the model.

from ModelRepository
mixed
__call(string $name, array $args = array())

__call

from ModelRepository
Structure
getConfig()

Method to get property Config

from ModelRepository
ModelRepository
setConfig(Structure $config)

Method to set property config

from ModelRepository
string
getName()

Method to get property Name

from ModelRepository
ModelRepository
setName(string $name)

Method to set property name

from ModelRepository
string
getCacheId(string $id = null)

getStoredId

from ModelRepository
ModelRepository
resetCache()

resetCache

from ModelRepository
Structure
getState()

Get the model state.

from ModelRepository
void
setState(Structure $state)

Set the model state.

from ModelRepository
mixed
get(string $key, mixed $default = null)

get

from ModelRepository
$this
set(string $key, mixed $value)

set

from ModelRepository
ModelRepository
reset()

reset

from ModelRepository
boolean
offsetExists(mixed $offset)

Is a property exists or not.

from ModelRepository
mixed
offsetGet(mixed $offset)

Get a property.

from ModelRepository
void
offsetSet(mixed $offset, mixed $value)

Set a value to property.

from ModelRepository
void
offsetUnset(mixed $offset)

Unset a property.

from ModelRepository
Structure
__get(string $name)

__get

from ModelRepository
void
bootDatabaseModelTrait(ModelRepository $model)

bootDatabaseModelTrait

from DatabaseModelTrait
AbstractDatabaseDriver
getDb()

getDb

from DatabaseModelTrait
DatabaseModelTrait
setDb(AbstractDatabaseDriver $db)

setDb

from DatabaseModelTrait
DatabaseModelTrait
transactionStart(boolean $nested = true)

transactionStart

from DatabaseModelTrait
DatabaseModelTrait
transactionCommit(boolean $nested = true)

transactionCommit

from DatabaseModelTrait
DatabaseModelTrait
transactionRollback(boolean $nested = true)

transactionRollback

from DatabaseModelTrait
CliOutputModelTrait
out(string $text, bool $nl = true)

out

from CliOutputModelTrait
string
in()

in

from CliOutputModelTrait
IOInterface
getIo()

Method to get property Io

from CliOutputModelTrait
CliOutputModelTrait
setIo(IOInterface $io)

Method to set property io

from CliOutputModelTrait
array|DataSet
getMigrations()

getMigrations

array
getVersions()

getVersions

int
getCurrentVersion()

getCurrentVersion

void
migrate(string $version = null)

migrate

void
executeMigration(Data $migrationItem, string $direction = 'up')

executeMigration

void
storeVersion(Data $migration, string $direction, string $start, string $end)

storeVersion

void
initLogTable(string $name = null)

initLogTable

mixed
getCommand()

Method to get property Command

MigrationsModel
setCommand(AbstractCommand $command)

Method to set property command

Details

in SingletonTrait at line line 32
static SingletonTrait getInstance(array $args)

getInstance

Parameters

array $args

Return Value

SingletonTrait

in SingletonTrait at line line 51
static mixed setInstance(object $instance)

setInstance

Parameters

object $instance

Return Value

mixed

in ModelRepository at line line 84
__construct(Structure|array $config = null, Structure $state = null, mixed $source = null)

Instantiate the model.

Parameters

Structure|array $config The model config.
Structure $state The model state.
mixed $source The data source.

in ModelRepository at line line 118
mixed __call(string $name, array $args = array())

__call

Parameters

string $name
array $args

Return Value

mixed

Exceptions

InvalidArgumentException

in ModelRepository at line line 145
Structure getConfig()

Method to get property Config

Return Value

Structure

in ModelRepository at line line 157
ModelRepository setConfig(Structure $config)

Method to set property config

Parameters

Structure $config

Return Value

ModelRepository Return self to support chaining.

in ModelRepository at line line 169
string getName()

Method to get property Name

Return Value

string

in ModelRepository at line line 195
ModelRepository setName(string $name)

Method to set property name

Parameters

string $name

Return Value

ModelRepository Return self to support chaining.

in ModelRepository at line line 209
string getCacheId(string $id = null)

getStoredId

Parameters

string $id

Return Value

string

in ModelRepository at line line 260
ModelRepository resetCache()

resetCache

Return Value

ModelRepository

in ModelRepository at line line 285
Structure getState()

Get the model state.

Return Value

Structure The state object.

in ModelRepository at line line 297
void setState(Structure $state)

Set the model state.

Parameters

Structure $state The state object.

Return Value

void

in ModelRepository at line line 310
mixed get(string $key, mixed $default = null)

get

Parameters

string $key
mixed $default

Return Value

mixed

in ModelRepository at line line 323
$this set(string $key, mixed $value)

set

Parameters

string $key
mixed $value

Return Value

$this

in ModelRepository at line line 335
ModelRepository reset()

reset

Return Value

ModelRepository

in ModelRepository at line line 349
boolean offsetExists(mixed $offset)

Is a property exists or not.

Parameters

mixed $offset Offset key.

Return Value

boolean

in ModelRepository at line line 362
mixed offsetGet(mixed $offset)

Get a property.

Parameters

mixed $offset Offset key.

Return Value

mixed The value to return.

Exceptions

InvalidArgumentException

in ModelRepository at line line 376
void offsetSet(mixed $offset, mixed $value)

Set a value to property.

Parameters

mixed $offset Offset key.
mixed $value The value to set.

Return Value

void

Exceptions

InvalidArgumentException

in ModelRepository at line line 389
void offsetUnset(mixed $offset)

Unset a property.

Parameters

mixed $offset Offset key to unset.

Return Value

void

Exceptions

InvalidArgumentException

in ModelRepository at line line 401
Structure __get(string $name)

__get

Parameters

string $name

Return Value

Structure

in DatabaseModelTrait at line line 36
void bootDatabaseModelTrait(ModelRepository $model)

bootDatabaseModelTrait

Parameters

ModelRepository $model

Return Value

void

in DatabaseModelTrait at line line 47
AbstractDatabaseDriver getDb()

getDb

Return Value

AbstractDatabaseDriver

in DatabaseModelTrait at line line 69
DatabaseModelTrait setDb(AbstractDatabaseDriver $db)

setDb

Parameters

AbstractDatabaseDriver $db

Return Value

DatabaseModelTrait Return self to support chaining.

in DatabaseModelTrait at line line 88
DatabaseModelTrait transactionStart(boolean $nested = true)

transactionStart

Parameters

boolean $nested

Return Value

DatabaseModelTrait

in DatabaseModelTrait at line line 102
DatabaseModelTrait transactionCommit(boolean $nested = true)

transactionCommit

Parameters

boolean $nested

Return Value

DatabaseModelTrait

in DatabaseModelTrait at line line 116
DatabaseModelTrait transactionRollback(boolean $nested = true)

transactionRollback

Parameters

boolean $nested

Return Value

DatabaseModelTrait

in CliOutputModelTrait at line line 35
CliOutputModelTrait out(string $text, bool $nl = true)

out

Parameters

string $text
bool $nl

Return Value

CliOutputModelTrait

in CliOutputModelTrait at line line 47
string in()

in

Return Value

string

in CliOutputModelTrait at line line 57
IOInterface getIo()

Method to get property Io

Return Value

IOInterface

in CliOutputModelTrait at line line 69
CliOutputModelTrait setIo(IOInterface $io)

Method to set property io

Parameters

IOInterface $io

Return Value

CliOutputModelTrait Return self to support chaining.

at line line 52
array|DataSet getMigrations()

getMigrations

Return Value

array|DataSet

at line line 93
array getVersions()

getVersions

Return Value

array

at line line 110
int getCurrentVersion()

getCurrentVersion

Return Value

int

at line line 129
void migrate(string $version = null)

migrate

Parameters

string $version

Return Value

void

at line line 211
void executeMigration(Data $migrationItem, string $direction = 'up')

executeMigration

Parameters

Data $migrationItem
string $direction

Return Value

void

Exceptions

Exception

at line line 273
void storeVersion(Data $migration, string $direction, string $start, string $end)

storeVersion

Parameters

Data $migration
string $direction
string $start
string $end

Return Value

void

at line line 300
void initLogTable(string $name = null)

initLogTable

Parameters

string $name

Return Value

void

at line line 324
mixed getCommand()

Method to get property Command

Return Value

mixed

at line line 336
MigrationsModel setCommand(AbstractCommand $command)

Method to set property command

Parameters

AbstractCommand $command

Return Value

MigrationsModel Return self to support chaining.