Download the PHP package kascat/easy-module without Composer
On this page you can find all versions of the php package kascat/easy-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kascat/easy-module
More information about kascat/easy-module
Files in kascat/easy-module
Package easy-module
Short Description Easy modular structure for laravel
License MIT
Homepage https://github.com/kascat
FAQ
Example:
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 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.
Informations about the package easy-module
Easy Module
Estrutura modular para o framework Laravel.
A estrutura modular oferece maior organização no projeto, centralizando o código de cada funcionalidade/feature em apenas um lugar, facilitando a criação e manutenção de projetos grandes e pequenos.
O pacote Easy Module não limita a utilização da estrutura padrão de arquivos do Laravel, podendo ser implementado em projetos novos e em andamento.
Instalação e configuração
Para instalar o pacote Easy Module basta seguir os três passos a seguir:
1. Instalação via composer
2. Configuração do Provider
O Provider do Easy Module disponibiliza alguns comandos artisan para auxiliar na criação dos módulos,
além de fazer a leitura automática das rotas mapeadas nos arquivos api.php e web.php em cada módulo,
e dos comandos personalizados no arquivo console.php (caso opte em adicionar no seu módulo).
Para isso, adicione a classe abaixo na sessão providers do arquivo config/app.php.
Exemplo:
Porém, se optar em fazer o mapeamento de rotas e comandos personalisados de outra maneira,
e não quiser que o Easy Module faça esse trabalho,
adicione a classe abaixo na sessão providers do arquivo config/app.php.
Essa classe libera apenas os comandos artisan do Easy Module, para auxiliar na criação dos módulos.
Exemplo:
3. Registre a pasta modules na configuração psr-4 do arquivo composer.json presente na raiz do seu projeto
Exemplo:
Criação de módulos
Para criar um módulo completo basta executar o comando php artisan easy:module [nome do módulo]
que irá gerar a estrutura padrão, porém o pacote Easy Module oferece uma lista de comandos,
que auxiliam na criação da estrutura e dos arquivos do seu módulo separadamente.
Os arquivos já são gerados com uma estrutura funcional de criação, leitura, edição, e exclusão (CRUD) para a tabela do seu banco de dados que está relacionada a model do módulo, apenas será necessário configurar a model e o request com as propriedades da tabela.
Comandos:
Criação de módulo completo com os principais arquivos:
Criação de Controller e dos arquivos relacionados (Controller, Request, Response, Api Route):
Criação de Model:
Criação de Service e Repository:
Criação de arquivos de rota (api.php e web.php):
Criação de arquivo de comandos artisan (console.php):
Substituição de arquivos:
O mesmo comando pode ser executado mais de uma vez para um módulo, porém os arquivos que já existirem não serão substituídos, serão criados novos arquivos com um sufixo único no nome, que podem ser adequados posteriormente.
Para que aconteça a substituição de um arquivo existente rode o comando com a flag --overwrite ou -O
Exemplo:
Estrutura
A estrutura modular é bem simples de se entender, cada módulo contém arquivos com uma finalidade específica.
Abaixo se encontra um exemplo da estrutura de um módulo (Sample),
gerado com o comando: php artisan easy:module sample
Caso o seu módulo não utilize algum dos arquivos criados automaticamente, ele pode ser removido, apenas se atente em alguma referência que possa ter ficado em outros arquivos que o utilizam.
Responsabilidades
Abaixo segue a responsabilidade de cada arquivo no módulo.
Model
O arquivo/classe model segue o mesmo padrão/estrutura das models originais do Laravel, se comunicando com a tabela do seu banco de dados, e realizando a definição das propriedades e relacionamentos normalmente.
O nome do arquivo e da classe recebe o nome do módulo no singular, ex: User.php User::class
Controller
O arquivo de controller também se comporta da mesma forma que as controllers tradicionais, ficando responsável em conter as funções que as rotas chamarão. Porém, com o diferencial de validar as requisições e formatar as respostas com uso dos arquivos apropriados (Request e Response).
Request
Utilizado para realizar as validações dos dados recebidos das requisições de cada rota.
Response
Utilizado para realizar formatações ou modificações nos dados de resposta da rota.
Repository
O repository tem somente a responsabilidade de montar as queries que serão executadas do banco de dados.
Service
O service fica com a responsabilidade de conter a lógica principal (regra de negócio) do módulo.
Api e Web
Os arquivos de rota api.php e web.php são utilizados para registrar as rotas do módulo,
da mesma forma que são definidas nos arquivos routes/api.php e routes/web.php do Laravel.
Console
O arquivo console.php é utilizado para criar comandos personalizados relacionados ao módulo,
e pode ser utilizado da mesma forma que o arquivo routes/console.php do Laravel,
podendo ser agendado normalmente em app/Console/Kernel.php.
