IndexMigrationAttribute
extends MigrationAttribute
in package
implements
JsonSerializable
generic class related to migration attribute about index changes
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $description : string
- $notes : array<string|int, mixed>
- $table : string
- $type : IndexType|null
Methods
- __construct() : mixed
- definition() : string
- getDescription() : string
- getNotes() : array<string|int, mixed>
- getTable() : string
- getType() : IndexType|null
- import() : $this
- jsonSerialize() : array<string|int, mixed>
- setDescription() : $this
- setNotes() : $this
- setTable() : $this
- setType() : $this
Properties
$description
private
string
$description
= ''
$notes
private
array<string|int, mixed>
$notes
= []
$table
private
string
$table
$type
private
IndexType|null
$type
= null
Methods
__construct()
public
__construct(string $table[, IndexType|null $type = null ][, string $description = '' ][, array<string|int, mixed> $notes = [] ]) : mixed
Parameters
- $table : string
-
name of the database table
- $type : IndexType|null = null
-
type of the index
- $description : string = ''
-
description of the migration
- $notes : array<string|int, mixed> = []
-
notes abour the migration/index
Tags
definition()
public
definition() : string
Tags
Return values
stringgetDescription()
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
stringgetType()
public
getType() : IndexType|null
Tags
Return values
IndexType|nullimport()
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>setDescription()
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
Tags
Return values
$thissetType()
public
setType(IndexType|null $type) : $this
Parameters
- $type : IndexType|null