IndexDefinition

class IndexDefinition extends Fluent (View source)

Properties

protected

$attributes

from Fluent

Methods

void

__construct(TValue> $attributes = [])

Create a new fluent instance.

from Fluent

get($key, $default = null)

No description

from Fluent

getAttributes()

No description

from Fluent

toArray()

No description

from Fluent

array

jsonSerialize()

No description

from Fluent

string

toJson(int $options = 0)

Convert the fluent instance to JSON.

from Fluent

bool

offsetExists(TKey $offset)

Determine if the given offset exists.

from Fluent

mixed

offsetGet(TKey $offset)

Get the value for a given offset.

from Fluent

void

offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

from Fluent

void

offsetUnset(TKey $offset)

Unset the value at the given offset.

from Fluent

$this

__call(TKey $method, $parameters)

Handle dynamic calls to the fluent instance to set attributes.

from Fluent

TValue|null

__get(TKey $key)

Dynamically retrieve the value of an attribute.

from Fluent

void

__set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

from Fluent

bool

__isset(TKey $key)

Dynamically check if an attribute is set.

from Fluent

void

__unset(TKey $key)

Dynamically unset an attribute.

from Fluent

$this

algorithm(string $algorithm) Specify an algorithm for the index (MySQL/PostgreSQL)

No description

$this

language(string $language) Specify a language for the full text index (PostgreSQL)

No description

$this

deferrable(bool $value = true) Specify that the unique index is deferrable (PostgreSQL)

No description

$this

initiallyImmediate(bool $value = true) Specify the default time to check the unique index constraint (PostgreSQL)

No description

Details

void __construct(TValue> $attributes = [])

Create a new fluent instance.

Parameters

TValue>

$attributes

Return Value

void

get($key, $default = null)

No description

Parameters

	$key
	$default

getAttributes()

No description

toArray()

No description

array jsonSerialize()

No description

Return Value

array

string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int

$options

Return Value

string

bool offsetExists(TKey $offset)

Determine if the given offset exists.

Parameters

TKey

$offset

Return Value

bool

mixed offsetGet(TKey $offset)

Get the value for a given offset.

Parameters

TKey

$offset

Return Value

mixed

void offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

Parameters

TKey	$offset
TValue	$value

Return Value

void

void offsetUnset(TKey $offset)

Unset the value at the given offset.

Parameters

TKey

$offset

Return Value

void

$this __call(TKey $method, $parameters)

Handle dynamic calls to the fluent instance to set attributes.

Parameters

TKey	$method
	$parameters

Return Value

$this

TValue|null __get(TKey $key)

Dynamically retrieve the value of an attribute.

Parameters

TKey

$key

Return Value

TValue|null

void __set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

Parameters

TKey	$key
TValue	$value

Return Value

void

bool __isset(TKey $key)

Dynamically check if an attribute is set.

Parameters

TKey

$key

Return Value

bool

void __unset(TKey $key)

Dynamically unset an attribute.

Parameters

TKey

$key

Return Value

void

$this algorithm(string $algorithm) Specify an algorithm for the index (MySQL/PostgreSQL)

No description

Parameters

string

$algorithm) Specify an algorithm for the index (MySQL/PostgreSQL

Return Value

$this

$this language(string $language) Specify a language for the full text index (PostgreSQL)

No description

Parameters

string

$language) Specify a language for the full text index (PostgreSQL

Return Value

$this

$this deferrable(bool $value = true) Specify that the unique index is deferrable (PostgreSQL)

No description

Parameters

bool

$value

Return Value

$this

$this initiallyImmediate(bool $value = true) Specify the default time to check the unique index constraint (PostgreSQL)

No description

Parameters

bool

$value

Return Value

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Database/Schema/IndexDefinition.html