1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. IndexDefinition

IndexDefinition

class IndexDefinition extends Fluent (View source)

Traits

InteractsWithData
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected $attributes from  Fluent

Methods

array
all(array|mixed|null $keys = null)

Retrieve all data from the instance.

from  InteractsWithData
mixed
data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

from  InteractsWithData
bool
exists(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
has(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

from  InteractsWithData
$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

from  InteractsWithData
bool
filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

from  InteractsWithData
bool
anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

from  InteractsWithData
$this|mixed
whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
missing(string|array $key)

Determine if the instance is missing a given key.

from  InteractsWithData
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

from  InteractsWithData
bool
isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

from  InteractsWithData
Stringable
str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
Stringable
string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
bool
boolean(string|null $key = null, bool $default = false)

Retrieve data as a boolean value.

from  InteractsWithData
int
integer(string $key, int $default = 0)

Retrieve data as an integer value.

from  InteractsWithData
float
float(string $key, float $default = 0.0)

Retrieve data as a float value.

from  InteractsWithData
Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

from  InteractsWithData
TEnum|null
enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

from  InteractsWithData
TEnum[]
enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

from  InteractsWithData
bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

from  InteractsWithData
array
array(array|string|null $key = null)

Retrieve data from the instance as an array.

from  InteractsWithData
Collection
collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

from  InteractsWithData
array
only(array|mixed $keys)

Get a subset containing the provided keys with values from the instance data.

from  InteractsWithData
array
except(array|mixed $keys)

Get all of the data except for a specified array of items.

from  InteractsWithData
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(TValue> $attributes = [])

Create a new fluent instance.

from  Fluent
get($key, $default = null)

No description

from  Fluent
$this
set(TKey $key, TValue $value)

Set an attribute on the fluent instance using "dot" notation.

from  Fluent
$this
fill(TValue> $attributes)

Fill the fluent instance with an array of attributes.

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
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
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

$this
nullsNotDistinct(bool $value = true) Specify that the null values should not be treated as distinct (PostgreSQL)

No description

Details

in InteractsWithData at line 19
abstract array all(array|mixed|null $keys = null)

Retrieve all data from the instance.

Parameters

array|mixed|null $keys

Return Value

array

in InteractsWithData at line 28
abstract protected mixed data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

in InteractsWithData at line 36
bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 47
bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 68
bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 85
$this|mixed whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 104
bool filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 123
bool isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 142
bool anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 163
$this|mixed whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a non-empty value for the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 182
bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 197
$this|mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 216
protected bool isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

Parameters

string $key

Return Value

bool

in InteractsWithData at line 230
Stringable str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 242
Stringable string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 256
bool boolean(string|null $key = null, bool $default = false)

Retrieve data as a boolean value.

Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.

Parameters

string|null $key
bool $default

Return Value

bool

in InteractsWithData at line 268
int integer(string $key, int $default = 0)

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

in InteractsWithData at line 280
float float(string $key, float $default = 0.0)

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

in InteractsWithData at line 295
Carbon|null date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

string $key
string|null $format
string|null $tz

Return Value

Carbon|null

Exceptions

InvalidFormatException

in InteractsWithData at line 317
TEnum|null enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

in InteractsWithData at line 335
TEnum[] enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

in InteractsWithData at line 353
protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

in InteractsWithData at line 364
array array(array|string|null $key = null)

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

in InteractsWithData at line 375
Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

in InteractsWithData at line 386
array only(array|mixed $keys)

Get a subset containing the provided keys with values from the instance data.

Parameters

array|mixed $keys

Return Value

array

in InteractsWithData at line 411
array except(array|mixed $keys)

Get all of the data except for a specified array of items.

Parameters

array|mixed $keys

Return Value

array

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Fluent at line 37
__construct(TValue> $attributes = [])

Create a new fluent instance.

Parameters

TValue> $attributes

in Fluent at line 51
get($key, $default = null)

No description

Parameters

$key
$default

in Fluent at line 63
$this set(TKey $key, TValue $value)

Set an attribute on the fluent instance using "dot" notation.

Parameters

TKey $key
TValue $value

Return Value

$this

in Fluent at line 76
$this fill(TValue> $attributes)

Fill the fluent instance with an array of attributes.

Parameters

TValue> $attributes

Return Value

$this

in Fluent at line 92
mixed value(string $key, mixed $default = null)

Get an attribute from the fluent instance.

Parameters

string $key
mixed $default

Return Value

mixed

in Fluent at line 108
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

in Fluent at line 155
getAttributes()

No description

in Fluent at line 165
toArray()

No description

in Fluent at line 175
array jsonSerialize()

No description

Return Value

array

in Fluent at line 186
string toJson(int $options = 0)

Convert the fluent instance to JSON.

Parameters

int $options

Return Value

string

in Fluent at line 197
bool offsetExists(TKey $offset)

Determine if the given offset exists.

Parameters

TKey $offset

Return Value

bool

in Fluent at line 208
mixed offsetGet(TKey $offset)

Get the value for a given offset.

Parameters

TKey $offset

Return Value

mixed

in Fluent at line 220
void offsetSet(TKey $offset, TValue $value)

Set the value at the given offset.

Parameters

TKey $offset
TValue $value

Return Value

void

in Fluent at line 231
void offsetUnset(TKey $offset)

Unset the value at the given offset.

Parameters

TKey $offset

Return Value

void

in Fluent at line 260
TValue|null __get(TKey $key)

Dynamically retrieve the value of an attribute.

Parameters

TKey $key

Return Value

TValue|null

in Fluent at line 272
void __set(TKey $key, TValue $value)

Dynamically set the value of an attribute.

Parameters

TKey $key
TValue $value

Return Value

void

in Fluent at line 283
bool __isset(TKey $key)

Dynamically check if an attribute is set.

Parameters

TKey $key

Return Value

bool

in Fluent at line 294
void __unset(TKey $key)

Dynamically unset an attribute.

Parameters

TKey $key

Return Value

void

at line 14
$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

at line 14
$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

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

No description

Parameters

bool $value

Return Value

$this

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

No description

Parameters

bool $value

Return Value

$this

at line 14
$this nullsNotDistinct(bool $value = true) Specify that the null values should not be treated as distinct (PostgreSQL)

No description

Parameters

bool $value

Return Value

$this