master

laravel/framework

Last updated at: 29/12/2023 09:23

IndexHint.php

TLDR

The IndexHint class represents an index hint for a database query. It stores the type of query hint and the name of the index.

Classes

IndexHint

The IndexHint class represents an index hint for a database query. It has the following properties:

  • type: The type of query hint (string).
  • index: The name of the index (string).

It also has a constructor that initializes the type and index properties when creating a new instance of the class.

<?php

namespace Illuminate\Database\Query;

class IndexHint
{
    /**
     * The type of query hint.
     *
     * @var string
     */
    public $type;

    /**
     * The name of the index.
     *
     * @var string
     */
    public $index;

    /**
     * Create a new index hint instance.
     *
     * @param  string  $type
     * @param  string  $index
     * @return void
     */
    public function __construct($type, $index)
    {
        $this->type = $type;
        $this->index = $index;
    }
}