Download the PHP package jot/hf-repository without Composer

On this page you can find all versions of the php package jot/hf-repository. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package hf-repository

hf-repository

O hf-repository é uma library extensível para gerenciamento de dados, oferecendo uma camada de abstração baseada no conceito de Repositories. Ele foi projetado para trabalhar de forma eficiente com o Elasticsearch, utilizando o padrão de design Repository Pattern para isolar a lógica de acesso aos dados. Simplifica a interação com índices, facilita o mapeamento de resultados para entidades e fornece suporte confiável para operações CRUD, busca avançada, paginação e geração de consultas dinâmicas.


Recursos Principais


Estrutura do Projeto

O projeto segue uma arquitetura limpa e bem organizada:


Tecnologias Utilizadas


Instalação

Para integrar o hf-repository no seu projeto Hyperf adicione as dependências necessárias ao seu projeto (via composer):

Após a instalação, publique os arquivos de configuração das dependências necessárias:

Exemplo de Uso

O comando mais importante desta biblioteca é a criação de um CRUD completo a partir de um índice do Elasticsearch.

O comando repo:crud vai criar as classes de entidades, repositório e controlador, além de já preparar toda a documentação do swagger e aplicar um rate limit padrão de 10 requisições por segundo.

`

Os detalhes de cada classe gerada por este comando serão explicadas no próximo tópico.

Criando as classes individualmente

Para criar individualmente as classes necessárias, siga os comandos na ordem abaixo:

1. Criando dinamicamente as classes das entidades

Utilize o comando de console para gerar as entidades relacionadas ao índice.

Conforme demonstrado, o comando vai analisar o mapping do índice informado e vai criar a entidade principal do índice e caso haja objetos e objetos nested no índice, uma classe de entidade será gerada para cada um deles.

Cada classe gerada já vem aplicada com as configurações do Swagger, criando as referências necessárias para a documentação do projeto.

2. Criando o repositório

Para criar o repositório relacionado ao índice do elasticsearch, utilize o comando abaixo:

O comando criará dentro do diretório uma classe User com o seguinte conteúdo:

3. Criando um controlador que fará uso do repositório

O comando repo:controller vai criar um controlador OrderController já preparado para receber os métodos GET, POST, PUT, DELETE e HEAD com as consultas e persistências realizadas pelo repositório gerado anteriormente.

Repare que o diretório final do controlador é baseada em uma versão. É possível definir a versão da api acrescentando a opção --api-version= ao comando.

Caso o arquivo do controlador exista, o comando perguntará se deseja substituí-lo.

Também é possível já forçar a substituição do arquivo diretamente no comando usando a opção --force

O arquivo do controlador gerado também vem com as configurações do Swagger aplicadas. Além disso, também são aplicadas configurações de rate limit para limitar as requisições à API.


All versions of hf-repository with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
hyperf/command Version ~3.1.0
hyperf/di Version ~3.1.0
hyperf/http-server Version ^3.1
hyperf/rate-limit Version ^3.1
hyperf/redis Version ^3.1
hyperf/swagger Version ^3.1
jot/hf-elastic Version ^0.17
jot/hf-validator Version ^0.1
zircote/swagger-php Version ^4.11
hyperf/translation Version ^3.1
hyperf/cache Version ^3.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jot/hf-repository contains the following files

Loading the files please wait ....