Download the PHP package gsferro/filtereasy without Composer
On this page you can find all versions of the php package gsferro/filtereasy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package filtereasy
Introdução
O FilterEasy é um pacote PHP que permite aplicar filtros em consultas de banco de dados de forma fácil e eficiente. Com ele, você pode criar consultas mais complexas e personalizadas, sem precisar escrever código SQL extenso.
Instalação
Instalação:
Implementação:
-
Na Model adicione a trait do pacote:
-
O pacote se utiliza do padrão
Mass Assignmentdo Laravel para tratar os filtros, mas somente os campos do array$fillablesão considerados, com exceção dos relacionamentos, que é explicado logo abaixo. -
Por default, todos os itens são tratados com a cláusula
where. -
Caso seja enviado um valor contendo um
array, sera utilizado owhereIn.- Para
array, coloque no name um[], exemplo:
- Para
-
Para verificações utilizando o operador
likeou uma verificação que force umbool, é necessário inicializar os seguintes atributos, respectivamente: -
Busca com Datas e Hora:
-
Para fazer verificação de periodos de data, usar os
sufixoa seguir, não precisam ser usados juntos::start:end
- Exemplos:
- Com o
:startserá implementadowhere('created_at', '>=', $value)created_at:start
- Com o
:endserá implementadowhere('updated_at', '<=', $value)updated_at:end
- Com o
-
Para implementar no formulário de filtro (ou se for utilizar diretamente no controller), basta colocar o attr:
name="created_at:start"|name="updated_at:end" -
Para implementar uma consulta como a do
whereBetween, basta colocar o mesmo campo 2x, cada uma com umsufixo- Exemplo:
deleted_at:start
deleted_at:end
- Exemplo:
- O sql gerado será assim: `
- Obs: Até a
v1.1era utilizadowhereDate, porém assim não é possivel enviar também a hora, caso o campo seja um datetime.
-
-
Para Relacionamento:
- Utilize a notação
relationName:relationFieldo pacote incluirá o relacionamento na query. -
Esta notação não precisa estar no
$fillable, mas orelationNameprecisa ser um relacionamento implementando na model.- Exemplo:
- Caso queira utilizar o
like, coloque orelationName:relationFieldno$likeFilterFields:
- Utilize a notação
-
Caso use
$guardedou outros campos que não estão no$fillable:-
Inicialize o atributo
$otherFilterFields: - Exemplo:
id,uuid,created_at,updated_at,deleted_ate etc.
-
-
Caso queria fazer um
aliasou precise com um unico paramentro pesquisar em várias colunas (muito comum em apis):- Inicialize o atributo
$combinedFilterFields: -
Exemplo:
- Nesse caso, ele verificara o valor enviado na posição
clientdentro dorequeste ira setar na query com oorWhere; - Ex: Caso tenha enviado um request assim:
client=123, osqlgerado sera:
- Nesse caso, ele verificara o valor enviado na posição
- Inicialize o atributo
-
Para implementar uma consulta utilizando
whereNullouwhereNotNull, no conceito deexistsdados na tabela, basta inicializar o atributo$nullableFilterFieldse passar o valorboolean, sendotrue|1parawhereNotNullefalse|0parawhereNull:-
Inicialize o atributo
$nullableFilterFields: - Exemplo:
updated_at=1eremember_token=false
-
Recursos Adicionais
- Você não precisa sanitizar os dados antes de enviar, o pacote limpa os campos que vierem em branco (
'') enull, mas aceita o0como um valor válido, pois pode ser usado como um operadorboleano - Use o
filterEasyRequest(), comoscope, para pegar todos os dados do request sem precisar passá-los por parâmetro. Pois ele chamara ofilterEasypasando a facaderequest()->all()como parâmetro -
Se você utilizar o pacote
prettus/l5-repositoryou qualquer outro paraRepository, recomendo criar a classeFilterEasyCriteriajá implementando ofilterEasyRequest()-
Implementando assim:
- E para usar, bastando simplesmente:
-
Solução de Problemas
Se você encontrar algum problema ao usar o FilterEasy, verifique se:
- A consulta de banco de dados está correta.
- Os filtros estão a ser aplicados corretamente.
- A versão do pacote está atualizada.
- Recursos Adicionais
- Se você inicializou os atributos na model
- Se você tiver um novo campo no model que não estiver listado
- Se você tiver um relacionamento que não estiver implementado na model
Contribuição
Se você deseja contribuir com o FilterEasy, por favor, siga as seguintes etapas:
- Faça um fork do repositório.
- Crie uma branch para sua contribuição.
- Faça as alterações necessárias.
- Envie um pull request.
License
O FilterEasy é licenciado sob a licença MIT. Leia o arquivo LICENSE para mais informações.