W3cubDocs

/Laravel 11

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

mixed

value(string $key, mixed $default = null)

Get an attribute from the fluent instance.

from Fluent

Fluent

scope(string $key, mixed $default = null)

Get the value of the given key as a new Fluent instance.

from Fluent

getAttributes()

No description

from Fluent

toArray()

No description

from Fluent

Collection

collect(string|null $key = null)

Convert the fluent instance to a Collection.

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

mixed value(string $key, mixed $default = null)

Get an attribute from the fluent instance.

Parameters

string	$key
mixed	$default

Return Value

mixed

Fluent scope(string $key, mixed $default = null)

Get the value of the given key as a new Fluent instance.

Parameters

string	$key
mixed	$default

Return Value

Fluent

getAttributes()

No description

toArray()

No description

Collection collect(string|null $key = null)

Convert the fluent instance to a Collection.

Parameters

string|null

$key

Return Value

Collection

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

$this

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