php clean architecture

Para entrar em contato em inglês, vá para readme.en

Arquitetura limpa PHP

Uma ferramenta para automatizar o controle sobre a qualidade da aplicação de aplicativos escritos no PHP, além de simplificar a análise e a visualização de algumas métricas.

A idéia de sua criação foi inspirada no livro Pure Architecture (Robert Martin). Se você ainda não leu, pode se familiarizar com suas principais idéias nas quais a ferramenta é baseada https://habr.com/en/post/504590/

Instalação

composer require v.chetkov/php-clean-architecture --dev

Configuração

Em seguida, copiamos uma configuração de amostra para a raiz do projeto

cp vendor/v.chetkov/php-clean-architecture/example.phpca-config.php phpca-config.php

All the details of the configuration are described in detail in the sample of the config https://github.com/chetkov/php-clean- Architecture/blob/master/example.phpca-config.php, as well as in articles https://habr.com/en/post/504590/ and https://habr.com/en/post/686236/

Uso

1. Formação de um relatório para análise.

vendor/bin/phpca-build-reports { ? path/to/phpca-config.php}

O relatório visualiza o estado atual do projeto, exibe claramente a relação entre os componentes, sua força, a remoção dos componentes da sequência principal e também destaca as dependências indesejadas e outros problemas arquitetônicos detectados com base na configuração.

2. Verifique se há CI.

vendor/bin/phpca-check { ? path/to/phpca-config.php}

Em caso de violação pelo código de restrições definido pela configuração, ele informa os problemas descobertos e conclui a execução com o erro. Recomenda -se adicionar o lançamento deste comando no CI (isso garante a conformidade do código que entra na assembléia, configurou restrições)

3. Estado permitido.

vendor/bin/phpca-allow-current-state { ? path/to/phpca-config.php}

A equipe manterá o estado atual do projeto, o relacionamento entre as classes existentes, em um arquivo separado. Com os lançamentos subsequentes de verificação da PHPCA, os problemas relacionados ao estado preservado serão ignorados.

Isso torna possível conectar facilmente o PHP-XLEAN-ARCHITETTION não apenas a novos projetos, mas também a existir e já ter problemas, cuja eliminação leva tempo.

4. Relatório/verificação de acordo com a lista de arquivos

Se você deseja verificar a presença de problemas ou criar um gráfico de dependência e conduzir uma análise não em todo o projeto, mas em alguma parte dele (por exemplo, de acordo com a lista de arquivos alterados), você pode definir o valor da variável de ambiente PHPCA_ALLOULED_PATHS :

 export PHPCA_ALLOWED_PATHS= ` git diff master --name-only ` PHPCA_REPORTS_DIR= ' phpca-report ' ; vendor/bin/phpca-build-reports { ? path/to/phpca-config.php}