TableMigrationAttribute
extends MigrationAttribute
in package
implements
JsonSerializable
generic class related to migration attribute about table changes
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $columns : array<string|int, mixed>
- $description : string
- $notes : array<string|int, mixed>
- $table : string
Methods
- __construct() : mixed
- definition() : string
- getColumns() : array<string|int, mixed>
- getDescription() : string
- getNotes() : array<string|int, mixed>
- getTable() : string
- import() : $this
- jsonSerialize() : array<string|int, mixed>
- setColumns() : $this
- setDescription() : $this
- setNotes() : $this
- setTable() : $this
Properties
$columns
private
array<string|int, mixed>
$columns
= []
$description
private
string
$description
= ''
$notes
private
array<string|int, mixed>
$notes
= []
$table
private
string
$table
Methods
__construct()
public
__construct(string $table[, array<string|int, mixed> $columns = [] ][, string $description = '' ][, array<string|int, mixed> $notes = [] ]) : mixed
Parameters
- $table : string
-
name of the database table
- $columns : array<string|int, mixed> = []
-
list of columns
- $description : string = ''
-
description of the migration
- $notes : array<string|int, mixed> = []
-
notes about the migration/table
Tags
definition()
public
definition() : string
Tags
Return values
stringgetColumns()
public
getColumns() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDescription()
public
getDescription() : string
Tags
Return values
stringgetNotes()
public
getNotes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getTable()
public
getTable() : string
Tags
Return values
stringimport()
public
import(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Tags
Return values
$thisjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>setColumns()
public
setColumns(array<string|int, mixed> $columns) : $this
Parameters
- $columns : array<string|int, mixed>
Tags
Return values
$thissetDescription()
public
setDescription(string $description) : $this
Parameters
- $description : string
Tags
Return values
$thissetNotes()
public
setNotes(array<string|int, mixed> $notes) : $this
Parameters
- $notes : array<string|int, mixed>
Tags
Return values
$thissetTable()
public
setTable(string $table) : $this
Parameters
- $table : string