FilterSearchTrait

A FilterSearchTrait é uma trait que adiciona funcionalidades de busca a um modelo no Laravel. Ela permite que você adicione filtros de busca com base em parâmetros de requisição.

Ela identifica quando está sendo chamada dentro de um comando e habilita automaticamente os parâmetros para a requisição search.

Exemplo de URL

Para utilizar a trait FilterSearchTrait com parâmetros de busca em uma URL, você pode passar o parâmetro search na query string da requisição. Veja o exemplo abaixo:

http://seu-dominio.com/api/modelo?search=termo

Neste exemplo, a busca será feita pelo termo termo nas colunas e relações configuradas.

Propriedades

• protected ?string $search = '': O termo de busca.
• protected array $searchableColumns = []: As colunas que podem ser buscadas.
• protected array $searchableRelations = []: As relações que podem ser buscadas.

Métodos

addSearchFilter(?string $search = ''): self

Adiciona filtros de busca com base nos parâmetros de requisição.

• Parâmetros:

  • ?string $search: O termo de busca. Se não for fornecido, será usado o termo search da requisição.

• Retorno:

  • self: A instância atual da classe.

Exemplo de Uso

$model->addSearchFilter('termo');

getSearch(): string

Obtém o termo de busca.

• Retorno:
  • string: O termo de busca.

setSearch(string $search): self

Define o termo de busca.

• Parâmetros:

  • string $search: O termo de busca.

• Retorno:

  • self: A instância atual da classe.

isSearchable(): bool

Verifica se a busca é possível com base nas colunas e relações configuradas.

• Retorno:
  • bool: true se a busca for possível, false caso contrário.