Глобальный поиск

Suggest Edit

Использование полнотекстного поиска

Платформа поставляется с пакетом Laravel Scout который является абстракцией для полнотекстового поиска в ваши модели Eloquent. Так как Scout не содержит самого «драйвера» поиска, требуется поставить и указать требуемое решение, это могут быть elasticsearch, algolia, sphinx или другие решение.

Для использования глобального поиска требуется добавить новый трейт Orchid\Platform\Searchable к модели, он уже включает в себя Laravel Scout.

Как пример модель может выглядеть так:


namespace App;

use Illuminate\Database\Eloquent\Model;
use Orchid\Platform\Searchable;

class Idea extends Model
{
    use Searchable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'description', 'photo', 'price'
    ];

    /**
     * Get the indexable data array for the model.
     *
     * @return array
     */
    public function toSearchableArray()
    {
        $array = $this->toArray();

        // Customize array...

        return $array;
    }
}

Для того, что бы приложение имело информацию о том, какие модели должны учавствовать в поиске, необходимо зарегистрировать их в сервис провайдере:

namespace App\Providers;

use App\Idea;
use Orchid\Platform\Dashboard;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Boot the application events.
     *
     * @param Dashboard $dashboard
     */
    public function boot(Dashboard $dashboard)
    {
        $dashboard->registerGlobalSearch([
          Idea::class,
          //...Models
        ]);
    }
}

Модификация результатов

В результатах поиска могут быть указаны следующие параметры:

  • label – Является группой, например: новости, пользователи и т.п.
  • title – Главная строка текста, например, фамилия и имя пользователя
  • subTitle – дополнительная строка, например, должность, статус
  • url – доступная ссылка для перехода/редактирования
  • avatar – Изображения

По умолчанию из модели будут браться указанные атрибуты. Для того, что бы определить какие данные будут передаваться, указываются методы с префиксом search в явном виде, например:

/**
 * @return string
 */
public function searchLabel(): ?string;

/**
 * @return string
 */
public function searchTitle(): ?string

/**
 * @return string
 */
public function searchSubTitle(): ?string

/**
 * @return string
 */
public function searchUrl(): ?string

/**
 * @return string
 */
public function searchAvatar(): ?string

Для модификации запросов, например, выдавать в результатах, только актуальные данные, можно модифицировать запрос с помощью переопределения метода:

public function searchQuery(string $query = null) : LengthAwarePaginator