1. class
  2. PhpMyAdmin
  3. \
  4. SqlParser
  5. \
  6. Components
  7. \
  8. IndexHint

IndexHint

final class IndexHint extends SerializableComponent (View source)

Parses an Index hint.

Methods

string
__toString()

No description

from  SerializableComponent
array
jsonSerialize()

No description

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

No description

string
build()

Builds the string representation of a component of this type.

Details

in SerializableComponent at line 14
string __toString()

No description

Return Value

string

in SerializableComponent at line 20
array jsonSerialize()

No description

Return Value

array

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

No description

Parameters

string $type

The type of hint (USE/FORCE/IGNORE)
string $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

at line 29
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