final class IndexHint implements Component (View source)

Parses an Index hint.

Properties

string|null $type

The type of hint (USE/FORCE/IGNORE)

string|null $indexOrKey

What the hint is for (INDEX/KEY)

string|null $for

The clause for which this hint is (JOIN/ORDER BY/GROUP BY)

Expression[] $indexes

List of indexes in this hint

Methods

__construct(string|null $type = null, string|null $indexOrKey = null, string|null $for = null, array $indexes = [])

No description

string
build()

Builds the string representation of a component of this type.

string
__toString()

No description

Details

__construct(string|null $type = null, string|null $indexOrKey = null, string|null $for = null, array $indexes = [])

No description

Parameters

string|null $type

the type of hint (USE/FORCE/IGNORE)

string|null $indexOrKey

What the hint is for (INDEX/KEY)

string|null $for

the clause for which this hint is (JOIN/ORDER BY/GROUP BY)

array $indexes

List of indexes in this hint

string build()

Builds the string representation of a component of this type.

In other words, this function represents the inverse function of {\PhpMyAdmin\SqlParser\Component::parse()}.

Return Value

string

string __toString()

No description

Return Value

string