Documentation

Blueprint
in package
implements BlueprintInterface

AbstractYes

Базовый класс Blueprint с общей реализацией для создания структуры таблиц БД.

Предоставляет методы для определения колонок, их типов и модификаторов. Реализует паттерн Fluent Interface для цепочки вызовов.

Table of Contents

Interfaces

BlueprintInterface
Интерфейс для построения SQL-запросов определения таблиц.

Properties

$columns  : array<string|int, mixed>
$table  : string
$tableOptions  : array<string|int, mixed>

Methods

__construct()  : mixed
Конструктор класса
after()  : $this
Устанавливает позицию последней добавленной колонки после указанной
bigInteger()  : $this
Добавляет колонку типа BIGINT
boolean()  : $this
Добавляет колонку типа BOOLEAN
char()  : $this
Добавляет колонку типа CHAR
comment()  : $this
Добавляет комментарий к последней добавленной колонке
date()  : $this
Добавляет колонку типа DATE
dateTime()  : $this
Добавляет колонку типа DATETIME
decimal()  : $this
Добавляет колонку типа DECIMAL
default()  : $this
Устанавливает значение по умолчанию для последней добавленной колонки
enum()  : $this
Добавляет колонку типа ENUM
first()  : $this
Устанавливает последнюю добавленную колонку первой в таблице
float()  : $this
Добавляет колонку типа FLOAT
index()  : $this
Добавляет индекс для последней добавленной колонки
integer()  : $this
Добавляет колонку типа INT
json()  : $this
Добавляет колонку типа JSON
nullable()  : $this
Делает последнюю добавленную колонку nullable
primary()  : $this
Делает последнюю добавленную колонку первичным ключом
rememberToken()  : void
Добавляет колонку remember_token для аутентификации
softDeletes()  : void
Добавляет колонку deleted_at для "мягкого" удаления
string()  : $this
Добавляет колонку типа VARCHAR
text()  : $this
Добавляет колонку типа TEXT
time()  : $this
Добавляет колонку типа TIME
timestamp()  : $this
Добавляет колонку типа TIMESTAMP
timestamps()  : void
Добавляет стандартные колонки created_at и updated_at
unique()  : $this
Добавляет ограничение UNIQUE для последней добавленной колонки
unsigned()  : $this
Делает последнюю числовую колонку беззнаковой (UNSIGNED)

Properties

$columns

protected array<string|int, mixed> $columns = []

Массив SQL-определений колонок

$table

protected string $table

Название таблицы

$tableOptions

protected array<string|int, mixed> $tableOptions = []

Дополнительные опции таблицы

Methods

__construct()

Конструктор класса

public __construct(string $table) : mixed
Parameters
$table : string

Название создаваемой/изменяемой таблицы

after()

Устанавливает позицию последней добавленной колонки после указанной

public after(string $column) : $this
Parameters
$column : string

Название колонки, после которой нужно разместить

Return values
$this

bigInteger()

Добавляет колонку типа BIGINT

public bigInteger(string $column[, int|null $length = null ]) : $this
Parameters
$column : string

Название колонки

$length : int|null = null

Длина числа (необязательно)

Return values
$this

boolean()

Добавляет колонку типа BOOLEAN

public boolean(string $column) : $this
Parameters
$column : string

Название колонки

Return values
$this

char()

Добавляет колонку типа CHAR

public char(string $column[, int $length = 255 ]) : $this
Parameters
$column : string

Название колонки

$length : int = 255

Фиксированная длина строки (по умолчанию 255)

Return values
$this

comment()

Добавляет комментарий к последней добавленной колонке

public comment(string $comment) : $this
Parameters
$comment : string

Текст комментария

Return values
$this

date()

Добавляет колонку типа DATE

public date(string $column) : $this
Parameters
$column : string

Название колонки

Return values
$this

dateTime()

Добавляет колонку типа DATETIME

public dateTime(string $column[, int|null $precision = null ]) : $this
Parameters
$column : string

Название колонки

$precision : int|null = null

Точность времени в секундах

Return values
$this

decimal()

Добавляет колонку типа DECIMAL

public decimal(string $column[, int $precision = 10 ][, int $scale = 2 ]) : $this
Parameters
$column : string

Название колонки

$precision : int = 10

Точность (общее количество цифр, по умолчанию 10)

$scale : int = 2

Количество цифр после запятой (по умолчанию 2)

Return values
$this

default()

Устанавливает значение по умолчанию для последней добавленной колонки

public default(mixed $value) : $this
Parameters
$value : mixed

Значение по умолчанию

Return values
$this

enum()

Добавляет колонку типа ENUM

public enum(string $column, array<string|int, mixed> $values) : $this
Parameters
$column : string

Название колонки

$values : array<string|int, mixed>

Допустимые значения перечисления

Return values
$this

first()

Устанавливает последнюю добавленную колонку первой в таблице

public first() : $this
Return values
$this

float()

Добавляет колонку типа FLOAT

public float(string $column[, int|null $precision = null ][, int|null $scale = null ]) : $this
Parameters
$column : string

Название колонки

$precision : int|null = null

Точность (общее количество цифр)

$scale : int|null = null

Количество цифр после запятой

Return values
$this

index()

Добавляет индекс для последней добавленной колонки

public index() : $this
Return values
$this

integer()

Добавляет колонку типа INT

public integer(string $column[, int|null $length = null ]) : $this
Parameters
$column : string

Название колонки

$length : int|null = null

Длина числа (необязательно)

Return values
$this

json()

Добавляет колонку типа JSON

public json(string $column) : $this
Parameters
$column : string

Название колонки

Return values
$this

nullable()

Делает последнюю добавленную колонку nullable

public nullable() : $this
Return values
$this

primary()

Делает последнюю добавленную колонку первичным ключом

public primary() : $this
Return values
$this

rememberToken()

Добавляет колонку remember_token для аутентификации

public rememberToken() : void

softDeletes()

Добавляет колонку deleted_at для "мягкого" удаления

public softDeletes() : void

string()

Добавляет колонку типа VARCHAR

public string(string $column[, int $length = 255 ]) : $this
Parameters
$column : string

Название колонки

$length : int = 255

Длина строки (по умолчанию 255)

Return values
$this

text()

Добавляет колонку типа TEXT

public text(string $column) : $this
Parameters
$column : string

Название колонки

Return values
$this

time()

Добавляет колонку типа TIME

public time(string $column[, int|null $precision = null ]) : $this
Parameters
$column : string

Название колонки

$precision : int|null = null

Точность времени в секундах

Return values
$this

timestamp()

Добавляет колонку типа TIMESTAMP

public timestamp(string $column[, int|null $precision = null ]) : $this
Parameters
$column : string

Название колонки

$precision : int|null = null

Точность времени в секундах

Return values
$this

timestamps()

Добавляет стандартные колонки created_at и updated_at

public timestamps() : void

unique()

Добавляет ограничение UNIQUE для последней добавленной колонки

public unique() : $this
Return values
$this

unsigned()

Делает последнюю числовую колонку беззнаковой (UNSIGNED)

public unsigned() : $this
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results