PHPackages                             sulcompany/router - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. sulcompany/router

ActiveLibrary[Framework](/categories/framework)

sulcompany/router
=================

Roteador simples com suporte a rotas dinâmicas e múltiplos parâmetros

v2.0.0(2mo ago)16MITPHPPHP >=7.4

Since Sep 17Pushed 2mo agoCompare

[ Source](https://github.com/sulcompany/router)[ Packagist](https://packagist.org/packages/sulcompany/router)[ RSS](/packages/sulcompany-router/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (1)Versions (8)Used By (0)

Router @SulCompany
==================

[](#router-sulcompany)

Um **roteador simples, flexível e sem dependências**, com suporte a:

- Rotas REST (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`)
- Parâmetros nomeados (`/user/{id}`)
- Parâmetros múltiplos dinâmicos (`/produto/{params*}`)
- Middlewares (`/route`, `[Controller::class, 'method']`, `Example\Middlewares\AuthMiddleware`)
- Grupos de rotas com prefixos
- Cache de rotas para otimização de performance
- Rotas nomeadas e geração de URLs
- Acesso fácil a dados de request e parâmetros dentro de controllers

---

🚀 Instalação
------------

[](#-instalação)

```
composer require sulcompany/router

🔹 Estrutura Básica do Projeto

addGlobalMiddleware(App\Http\Middlewares\AuthMiddleware::class);

// Registrar rotas (simples ou grupos)
// ...

$dispatcher = new Dispatcher($router);
$dispatcher->dispatch();

if ($dispatcher->error()) {
    echo "Erro HTTP: " . $dispatcher->error();
}

⚡ Fluxo do Router

Inicializar Router

Adicionar middlewares globais

Habilitar cache de rotas (opcional)

Registrar rotas simples ou grupos

Criar Dispatcher

Executar dispatch

Acessar dados ou tratar erros ($dispatcher->data(), $dispatcher->params(), $dispatcher->error())

📋 Tabela de Métodos do Router

| Método                                        | Descrição                             | Exemplo                                                                                                                   |
| --------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `get($uri, $handler, $name=null)`             | Registra rota GET                     | `$router->get("/about", [SiteController::class,'about'], 'site.about');`                                                  |
| `post($uri, $handler, $name=null)`            | Registra rota POST                    | `$router->post("/user/register", [UserController::class,'register'], 'user.register');`                                   |
| `put($uri, $handler, $name=null)`             | Registra rota PUT                     | `$router->put("/user/{id}/profile", [UserController::class,'updateProfile'], 'user.updateProfile');`                      |
| `patch($uri, $handler, $name=null)`           | Registra rota PATCH                   | `$router->patch("/user/{id}/photo", [UserController::class,'updatePhoto'], 'user.updatePhoto');`                          |
| `delete($uri, $handler, $name=null)`          | Registra rota DELETE                  | `$router->delete("/user/{id}", [UserController::class,'delete'], 'user.delete');`                                         |
| `group($prefix, $callback, $middleware=null)` | Agrupa rotas com prefixo e middleware | `$router->group('admin', fn($r)=>$r->get('/', [DashController::class,'index']), middleware: AuthAdminMiddleware::class);` |
| `addGlobalMiddleware($middleware)`            | Adiciona middlewares globais          | `$router->addGlobalMiddleware(AuthMiddleware::class);`                                                                    |
| `enableCache($file)`                          | Habilita cache de rotas               | `$router->enableCache(__DIR__.'/cache/routes.php');`                                                                      |
| `loadCache(): bool`                           | Carrega rotas do cache                | `$router->loadCache();`                                                                                                   |
| `routes(): array`                             | Retorna todas as rotas registradas    | `$router->routes();`                                                                                                      |
| `urlFor($name, $params=[], $query=[])`        | Gera URL para rota nomeada            | `$router->urlFor('user.show', ['id'=>42], ['ref'=>'email']);`
                                                            |

🗂 Tabela de Métodos do Dispatcher

| Método               | Descrição                                     | Exemplo                    |
| -------------------- | --------------------------------------------- | -------------------------- |
| `dispatch(): bool`   | Executa a rota correspondente à requisição    | `$dispatcher->dispatch();` |
| `error(): ?int`      | Retorna código HTTP do erro (404, 405, etc)   | `$dispatcher->error();`    |
| `data(): ?array`     | Retorna dados da requisição (GET, POST, JSON) | `$dispatcher->data();`     |
| `params(): ?array`   | Retorna parâmetros extraídos da rota          | `$dispatcher->params();`   |
| `current(): ?object` | Retorna informações da rota atual             | `$dispatcher->current();`  |

🏷 Named Routes & URL Generation

| Exemplo                                                                        | Resultado                                                |
| ------------------------------------------------------------------------------ | -------------------------------------------------------- |
| `$router->urlFor('user.show', ['id'=>42]);`                                    | `https://www.dominio.com/user/42`                        |
| `$router->urlFor('product.show', ['slug'=>'produto'], ['ref'=>'newsletter']);` | `https://www.dominio.com/product/produto?ref=newsletter` |

📁 Grupos de Rotas & Middleware

$router->group('admin', function($router){
    $router->get('/dashboard', [Admin\DashController::class,'index'], 'admin.dashboard');
    $router->get('/users', [Admin\UserController::class,'list'], 'admin.users.list');
}, middleware: [AuthAdminMiddleware::class]);

Prefixo automático aplicado: /admin/dashboard
Middlewares do grupo + globais aplicados em cada rota do grupo

📌 Parâmetros Múltiplos Dinâmicos
$router->get('/files/{path*}', [FileController::class,'download'], 'files.download');

// URL: /files/docs/2025/relatorio.pdf
// $dispatcher->params() => ['path' => ['docs','2025','relatorio.pdf']]

📝 Acesso a Dados e Parâmetros em Controllers

class UserController {
    public function show(array $data, array $params) {
        $id = $params['id'] ?? null;
        $email = $data['email'] ?? null;
        echo "User ID: $id, Email: $email";
    }
}

$data: GET, POST e JSON da requisição
$params: parâmetros da rota ({id}, {slug}, {params*})

⚡ Cache de Rotas
Otimiza performance evitando recompilar regex a cada requisição
Sempre que adicionar novas rotas, limpe ou regenere o cache

$router->enableCache(__DIR__.'/cache/routes.php');

if (!$router->loadCache()) {
    $router->get('/about', [SiteController::class,'about']);

    $router->compile();
    $router->cacheCompiledRoutes();
}

✅ Resumo Visual do Fluxo
[ Router ]
  ↓ addGlobalMiddleware
  ↓ enableCache (opcional)
  ↓ register routes (get, post, put, patch, delete)
  ↓ group routes (prefix + middleware)
  ↓ compile & cache (opcional)
  ↓
[ Dispatcher ]
  ↓ dispatch()
  ↓
[ Controller / Closure ]
  ↓
[ Response / Error Handling ]

Credits

Francisco Dulo (GitHub
)

Sul Company Lda (GitHub
)

Todos os colaboradores (Contributors
)

```

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance85

Actively maintained with recent releases

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~34 days

Total

7

Last Release

80d ago

Major Versions

v1.5.0 → v2.0.02026-04-14

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/202392024?v=4)[Sul Company Lda](/maintainers/sulcompany)[@sulcompany](https://github.com/sulcompany)

---

Top Contributors

[![jobpires14](https://avatars.githubusercontent.com/u/191461388?v=4)](https://github.com/jobpires14 "jobpires14 (10 commits)")

### Embed Badge

![Health badge](/badges/sulcompany-router/health.svg)

```
[![Health](https://phpackages.com/badges/sulcompany-router/health.svg)](https://phpackages.com/packages/sulcompany-router)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.8k543.8M20.1k](/packages/laravel-framework)[symfony/symfony

The Symfony PHP framework

31.4k87.2M2.2k](/packages/symfony-symfony)[cakephp/cakephp

The CakePHP framework

8.9k19.5M1.8k](/packages/cakephp-cakephp)[bref/bref

Bref is a framework to write and deploy serverless PHP applications on AWS Lambda.

3.4k10.6M67](/packages/bref-bref)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[typo3/cms

TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL.

1.2k1.9M122](/packages/typo3-cms)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)