MigrationModel
extends BaseModel
in package
Manages plugin migrations
Tags
Table of Contents
- $code : string
- $description : string
- $exists : bool
- $originalScriptFileName : mixed
- $scriptFileName : string
- $version : string
- $fillable : mixed
- $originalVersion : mixed
- $pluginCodeObj : PluginCode
- $updatedData : mixed
- $validationMessages : mixed
- $validationRules : mixed
- apply() : mixed
- deleteModel() : mixed
- fill() : mixed
- getModelPluginName() : mixed
- getNextVersion() : mixed
- getPluginCodeObj() : mixed
- initVersion() : mixed
- isApplied() : mixed
- isNewModel() : mixed
- load() : mixed
- makeScriptFileNameUnique() : mixed
- rollback() : mixed
- save() : mixed
- Saves the migration and applies all outstanding migrations for the plugin.
- setPluginCode() : mixed
- Sets a string code of a plugin the model is associated with
- setPluginCodeObj() : mixed
- Sets a code object of a plugin the model is associated with
- validate() : mixed
- assignFileName() : mixed
- deleteVersion() : mixed
- getOriginalFileContents() : mixed
- getPluginUpdatesPath() : mixed
- getPluginVersionInformation() : mixed
- insertOrUpdateVersion() : mixed
- loadScriptFile() : mixed
- removeScriptFile() : mixed
- rollbackSaving() : mixed
- rollbackScriptFile() : mixed
- rollbackVersionFile() : mixed
- saveScriptFile() : mixed
- validateBeforeCreate() : mixed
Properties
$code
public
string
$code
The migration PHP code string
$description
public
string
$description
The migration description
$exists
public
bool
$exists
= false
This property is used by the system internally.
$originalScriptFileName
public
mixed
$originalScriptFileName
$scriptFileName
public
string
$scriptFileName
The migration script file name. Currently only migrations with a single (or none) script file are supported by Builder editors.
$version
public
string
$version
Migration version string
$fillable
protected
static mixed
$fillable
= ['version', 'description', 'code']
$originalVersion
protected
mixed
$originalVersion
$pluginCodeObj
protected
PluginCode
$pluginCodeObj
= null
The plugin code object the model is associated with.
$updatedData
protected
mixed
$updatedData
= []
$validationMessages
protected
mixed
$validationMessages
= []
$validationRules
protected
mixed
$validationRules
= ['version' => ['required', 'regex:/^[0-9]+\.[0-9]+\.[0-9]+$/', 'uniqueVersion'], 'description' => ['required'], 'scriptFileName' => ['regex:/^[a-z]+[a-z0-9_]+$/']]
Methods
apply()
public
apply() : mixed
Return values
mixed —deleteModel()
public
deleteModel() : mixed
Return values
mixed —fill()
public
fill(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —getModelPluginName()
public
getModelPluginName() : mixed
Return values
mixed —getNextVersion()
public
getNextVersion() : mixed
Return values
mixed —getPluginCodeObj()
public
getPluginCodeObj() : mixed
Return values
mixed —initVersion()
public
initVersion(mixed $versionType) : mixed
Parameters
- $versionType : mixed
Return values
mixed —isApplied()
public
isApplied() : mixed
Return values
mixed —isNewModel()
public
isNewModel() : mixed
Return values
mixed —load()
public
load(mixed $versionNumber) : mixed
Parameters
- $versionNumber : mixed
Return values
mixed —makeScriptFileNameUnique()
public
makeScriptFileNameUnique() : mixed
Return values
mixed —rollback()
public
rollback() : mixed
Return values
mixed —save()
Saves the migration and applies all outstanding migrations for the plugin.
public
save([mixed $executeOnSave = true ]) : mixed
Parameters
- $executeOnSave : mixed = true
Return values
mixed —setPluginCode()
Sets a string code of a plugin the model is associated with
public
setPluginCode(string $code) : mixed
Parameters
- $code : string
-
Specifies the plugin code
Return values
mixed —setPluginCodeObj()
Sets a code object of a plugin the model is associated with
public
setPluginCodeObj(PluginCode $obj) : mixed
Parameters
- $obj : PluginCode
-
Specifies the plugin code object
Return values
mixed —validate()
public
validate() : mixed
Return values
mixed —assignFileName()
protected
assignFileName() : mixed
Return values
mixed —deleteVersion()
protected
deleteVersion() : mixed
Return values
mixed —getOriginalFileContents()
protected
getOriginalFileContents() : mixed
Return values
mixed —getPluginUpdatesPath()
protected
getPluginUpdatesPath([mixed $fileName = null ]) : mixed
Parameters
- $fileName : mixed = null
Return values
mixed —getPluginVersionInformation()
protected
getPluginVersionInformation() : mixed
Return values
mixed —insertOrUpdateVersion()
protected
insertOrUpdateVersion() : mixed
Return values
mixed —loadScriptFile()
protected
loadScriptFile() : mixed
Return values
mixed —removeScriptFile()
protected
removeScriptFile() : mixed
Return values
mixed —rollbackSaving()
protected
rollbackSaving(mixed $originalVersionData, mixed $originalScriptFileContents) : mixed
Parameters
- $originalVersionData : mixed
- $originalScriptFileContents : mixed
Return values
mixed —rollbackScriptFile()
protected
rollbackScriptFile(mixed $fileContents) : mixed
Parameters
- $fileContents : mixed
Return values
mixed —rollbackVersionFile()
protected
rollbackVersionFile(mixed $fileData) : mixed
Parameters
- $fileData : mixed
Return values
mixed —saveScriptFile()
protected
saveScriptFile() : mixed
Return values
mixed —validateBeforeCreate()
protected
validateBeforeCreate() : mixed