DatabaseTableModel
extends BaseModel
in package
Manages plugin database tables.
Tags
Table of Contents
- $columns : mixed
- $exists : bool
- $name : string
- $fillable : mixed
- $pluginCodeObj : PluginCode
- $schema : Schema
- $schemaManager : AbstractSchemaManager
- $tableInfo : Table
- $updatedData : mixed
- $validationMessages : mixed
- $validationRules : mixed
- fill() : mixed
- generateCreateOrUpdateMigration() : mixed
- generateDropMigration() : mixed
- getModelPluginName() : mixed
- getPluginCodeObj() : mixed
- getSchema() : mixed
- isNewModel() : mixed
- listPluginTables() : mixed
- load() : mixed
- Loads the table from the database.
- 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
- tableExists() : mixed
- validate() : mixed
- createMigrationObject() : mixed
- getSchemaManager() : mixed
- loadColumnsFromTableInfo() : mixed
- validateAutoIncrementColumns() : mixed
- validateBeforeCreate() : mixed
- validateColumnNameLengths() : mixed
- validateColumns() : mixed
- validateColumnsLengthParameter() : mixed
- validateDefaultValues() : mixed
- validateDuplicateColumns() : mixed
- validateDuplicatePrimaryKeys() : mixed
- validateUnsignedColumns() : mixed
Properties
$columns
public
mixed
$columns
= []
$exists
public
bool
$exists
= false
This property is used by the system internally.
$name
public
string
$name
Specifies the database table model
$fillable
protected
static mixed
$fillable
= ['name', 'columns']
$pluginCodeObj
protected
PluginCode
$pluginCodeObj
= null
The plugin code object the model is associated with.
$schema
protected
static Schema
$schema
= null
Contains the database schema
$schemaManager
protected
static AbstractSchemaManager
$schemaManager
= null
Contains the database schema
$tableInfo
protected
Table
$tableInfo
Table details loaded from the database.
$updatedData
protected
mixed
$updatedData
= []
$validationMessages
protected
mixed
$validationMessages
= []
$validationRules
protected
mixed
$validationRules
= ['name' => ['required', 'regex:/^[a-z]+[a-z0-9_]+$/', 'tablePrefix', 'uniqueTableName', 'max:64']]
Methods
fill()
public
fill(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —generateCreateOrUpdateMigration()
public
generateCreateOrUpdateMigration() : mixed
Return values
mixed —generateDropMigration()
public
generateDropMigration() : mixed
Return values
mixed —getModelPluginName()
public
getModelPluginName() : mixed
Return values
mixed —getPluginCodeObj()
public
getPluginCodeObj() : mixed
Return values
mixed —getSchema()
public
static getSchema() : mixed
Return values
mixed —isNewModel()
public
isNewModel() : mixed
Return values
mixed —listPluginTables()
public
static listPluginTables(mixed $pluginCode) : mixed
Parameters
- $pluginCode : mixed
Return values
mixed —load()
Loads the table from the database.
public
load(string $name) : mixed
Parameters
- $name : string
-
Specifies the table name.
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 —tableExists()
public
static tableExists(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —validate()
public
validate() : mixed
Return values
mixed —createMigrationObject()
protected
createMigrationObject(mixed $code, mixed $description) : mixed
Parameters
- $code : mixed
- $description : mixed
Return values
mixed —getSchemaManager()
protected
static getSchemaManager() : mixed
Return values
mixed —loadColumnsFromTableInfo()
protected
loadColumnsFromTableInfo() : mixed
Return values
mixed —validateAutoIncrementColumns()
protected
validateAutoIncrementColumns() : mixed
Return values
mixed —validateBeforeCreate()
protected
validateBeforeCreate() : mixed
Return values
mixed —validateColumnNameLengths()
protected
validateColumnNameLengths() : mixed
Return values
mixed —validateColumns()
protected
validateColumns() : mixed
Return values
mixed —validateColumnsLengthParameter()
protected
validateColumnsLengthParameter() : mixed
Return values
mixed —validateDefaultValues()
protected
validateDefaultValues() : mixed
Return values
mixed —validateDuplicateColumns()
protected
validateDuplicateColumns() : mixed
Return values
mixed —validateDuplicatePrimaryKeys()
protected
validateDuplicatePrimaryKeys() : mixed
Return values
mixed —validateUnsignedColumns()
protected
validateUnsignedColumns() : mixed