laravel er diagram generator

Gerador de Diagrama Laravel ER

Este pacote permite gerar diagramas de relação de entidade inspecionando os relacionamentos definidos em seus arquivos de modelo. É altamente personalizável. Nos bastidores, ele usa o GraphViz para gerar o gráfico.

Se você quiser aprender como criar pacotes PHP reutilizáveis, dê uma olhada no meu próximo curso em vídeo sobre Desenvolvimento de Pacotes PHP.

Pré-requisitos

A versão mínima necessária do PHP é 7.1.0.

Requisitos

Este pacote requer a ferramenta graphviz .

Você pode instalar o Graphviz no MacOS via homebrew:

brew install graphviz

Ou, se você estiver usando Homestead:

sudo apt-get install graphviz

Para instalar o Graphviz no Windows, baixe-o do site oficial.

Instalação

Você pode instalar o pacote via compositor:

composer require beyondcode/laravel-er-diagram-generator --dev

Se você estiver usando o Laravel 5.5+, o pacote registrará automaticamente o provedor de serviços para você.

Se estiver usando o Lumen, você precisará adicionar o seguinte ao bootstrapapp.php :

 # Register Service Providers
$ app -> register ( BeyondCode  ErdGenerator  ErdGeneratorServiceProvider ::class);

Uso

Por padrão, o pacote detectará automaticamente todos os modelos em seu diretório app/Models que estendem a classe Eloquent Model. Se desejar definir explicitamente onde seus modelos estão localizados, você pode publicar o arquivo de configuração usando o seguinte comando.

php artisan vendor:publish --provider=BeyondCode \ ErdGenerator \ ErdGeneratorServiceProvider

Se estiver usando o Lumen e quiser personalizar a configuração, você precisará copiar o arquivo de configuração do diretório do fornecedor:

cp ./vendor/beyondcode/laravel-er-diagram-generator/config/config.php config/erd-generator.php

Gerando Diagramas

Você pode gerar diagramas de relação de entidade usando o comando artesão fornecido:

php artisan generate:erd

Isso irá gerar um arquivo chamado graph.png .

Você também pode especificar um nome de arquivo personalizado:

php artisan generate:erd output.png

Ou use um dos outros formatos de saída, como SVG:

php artisan generate:erd output.svg --format=svg

Personalização

Por favor, dê uma olhada no arquivo de configuração erd-generator.php publicado para todas as opções de personalização disponíveis.

Exemplos

Aqui estão alguns exemplos retirados da base de código Laravel.io.

Teste

composer test

Registro de alterações

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Contribuindo

Consulte CONTRIBUINDO para obter detalhes.

Segurança

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [email protected] em vez de usar o rastreador de problemas.

Créditos

• Marcel Pociot
• Todos os colaboradores

Licença

A licença MIT (MIT). Consulte Arquivo de licença para obter mais informações.