class IndexHint extends Component (View source)

Parses an Index hint.

Properties

string $type

The type of hint (USE/FORCE/IGNORE)

string $indexOrKey

What the hint is for (INDEX/KEY)

string $for

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

array $indexes

List of indexes in this hint

Methods

static mixed
parse(Parser $parser, TokensList $list, array $options = [])

No description

static mixed
build(mixed $component, array $options = [])

No description

string
__toString()

Builds the string representation of a component of this type.

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

No description

Details

static mixed parse(Parser $parser, TokensList $list, array $options = [])

No description

Parameters

Parser $parser

the parser that serves as context

TokensList $list

the list of tokens that are being parsed

array $options

parameters for parsing

Return Value

mixed

static mixed build(mixed $component, array $options = [])

No description

Parameters

mixed $component

the component to be built

array $options

parameters for building

Return Value

mixed

string __toString()

Builds the string representation of a component of this type.

Return Value

string

See also

static::build

__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