Download the PHP package casdorio/annotation-router without Composer
On this page you can find all versions of the php package casdorio/annotation-router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download casdorio/annotation-router
More information about casdorio/annotation-router
Files in casdorio/annotation-router
Package annotation-router
Short Description A library to enable route annotations in CodeIgniter 4
License MIT
Informations about the package annotation-router
Annotation Router for CodeIgniter 4
Available in: English
Descrição
O annotation-router é um pacote para CodeIgniter 4 que permite usar anotações ou atributos em controladores sem modificar a configuração do framework. Com este pacote, você pode definir rotas diretamente nas classes de controle, melhorando a organização e a legibilidade do código.
Observação: Este projeto ainda está em fase de testes e desenvolvimento. No entanto, a princípio, está funcionando perfeitamente.
Requisitos
- PHP 8.0 ou superior
- CodeIgniter 4.x
Instalação
1. Instalar via Composer
Execute o seguinte comando no terminal dentro do diretório do seu projeto CodeIgniter:
Uso
Definição de Controladores
Você pode usar tanto anotações quanto atributos para definir controladores e suas rotas. Caso ambos sejam utilizados, os atributos prevalecerão sobre as anotações.
Usando Anotações
Usando Atributos
Controladores Sem Grupo
Se um controlador não estiver definido como parte de um grupo, ele ainda deve ser adicionado como controlador usando a anotação ou atributo Controller
.
Exemplo de Controlador Simples
Opções Possíveis
As opções aceitas em Controller
e Route
incluem, mas não se limitam a:
- namespace: O namespace onde o controlador está localizado.
- filters: Um ou mais filtros que devem ser aplicados a este controlador ou método.
- methods: Métodos HTTP permitidos para a rota (GET, POST, PUT, DELETE, etc.).
- options: Qualquer outra configuração que o roteador do CodeIgniter permita.
Observações
- Detecção de Controladores: Para que um controlador seja detectado, ele deve ter uma anotação ou atributo
Controller
. Isso se aplica tanto a controladores que definem um grupo quanto a controladores simples sem grupo. - Opções: As opções podem ser utilizadas tanto na anotação
Controller
quanto na anotaçãoRoute
, permitindo passar parâmetros como namespace, filtros, etc.
Visualização de Rotas
Para visualizar as rotas cadastradas, acesse a URL http://seu_dominio/routes
. As rotas só serão exibidas se o aplicativo estiver em modo de desenvolvimento.
Ambiente de Desenvolvimento
As rotas só serão exibidas se você estiver em modo de desenvolvimento. Certifique-se de que sua configuração de ambiente esteja definida corretamente para ver as rotas.
Contribuição
Sinta-se à vontade para contribuir para o projeto. Para isso:
- Faça um fork do repositório.
- Crie uma nova branch (
git checkout -b feature/nome-da-sua-funcionalidade
). - Faça suas alterações e commit (
git commit -m 'Adiciona nova funcionalidade'
). - Envie para o seu repositório (
git push origin feature/nome-da-sua-funcionalidade
). - Crie um Pull Request.
Licença
Este projeto está licenciado sob a MIT License.