SchemaConfig
in package
Configuration for a Schema.
Table of Contents
- $defaultTableOptions : array<string|int, mixed>
- $hasExplicitForeignKeyIndexes : bool
- $maxIdentifierLength : int
- $name : string|null
- getDefaultTableOptions() : array<string|int, mixed>
- Gets the default options that are passed to Table instances created with Schema#createTable().
- getMaxIdentifierLength() : int
- getName() : string|null
- Gets the default namespace of schema objects.
- hasExplicitForeignKeyIndexes() : bool
- setDefaultTableOptions() : void
- setExplicitForeignKeyIndexes() : void
- setMaxIdentifierLength() : void
- setName() : void
- Sets the default namespace name of schema objects.
Properties
$defaultTableOptions
protected
array<string|int, mixed>
$defaultTableOptions
= []
$hasExplicitForeignKeyIndexes
protected
bool
$hasExplicitForeignKeyIndexes
= false
Tags
$maxIdentifierLength
protected
int
$maxIdentifierLength
= 63
$name
protected
string|null
$name
Methods
getDefaultTableOptions()
Gets the default options that are passed to Table instances created with Schema#createTable().
public
getDefaultTableOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMaxIdentifierLength()
public
getMaxIdentifierLength() : int
Return values
int —getName()
Gets the default namespace of schema objects.
public
getName() : string|null
Return values
string|null —hasExplicitForeignKeyIndexes()
public
hasExplicitForeignKeyIndexes() : bool
Tags
Return values
bool —setDefaultTableOptions()
public
setDefaultTableOptions(array<string|int, mixed> $defaultTableOptions) : void
Parameters
- $defaultTableOptions : array<string|int, mixed>
Return values
void —setExplicitForeignKeyIndexes()
public
setExplicitForeignKeyIndexes(bool $flag) : void
Parameters
- $flag : bool
Tags
Return values
void —setMaxIdentifierLength()
public
setMaxIdentifierLength(int $length) : void
Parameters
- $length : int
Return values
void —setName()
Sets the default namespace name of schema objects.
public
setName(string $name) : void
Parameters
- $name : string
-
The value to set.