Chevere Router

A strict, strong typed router for PHP.

rodber   GitHub

New from Chevere is the chevere/router package for PHP. This software provides a strict typed router, enabling to create a more predictable HTTP routing for PHP.

Router software for PHP trends into practices like optional path wildcards, multiple resolver contexts and tons of functionality that does the same but with different API. Have you ever seen a car with two steering wheels? That's how most PHP router software looks to me.

Routing is the system where HTTP endpoints gets defined, where users determine the most relevant binding for a website. A weak routing experience degrades the quality of the application.

# Introduction

My motivation with Router was to create a package focused in a neat syntax and strict handling. The goal of this package is to enable a more robust syntax for routing binding.

Here, it looks neat and clean:

use function Chevere\Router\router;
use function Chevere\Router\routes;
use function Chevere\Router\route;

    web: routes(
            path: '/',
            GET: new HomeGetController(),
            path: '/product/{id}',
            GET: new ProductGetController(),
            POST: new ProductPostController(),

# Features

  • Define path, name, view, middleware and HTTP method to controller binding using named arguments.
  • HTTP method binding works with Http Controller objects.
  • Wildcards ({id} in the code above) inherits regex from parameter attributes at controller layer.
    • Can be implicit ({id}) or explicit ({id:[0-9]+}).
    • Detects conflicts for all endpoints.
  • Supports route groups, define web, api, admin and any group you may need to add.
  • Supports PSR middleware.

# How it works

Under the hood Router detects path collision, controllers conflicts, path wildcard regex from attributes and it uses FastRoute for request matching. You don't need to worry about anything about it, I just wanted to write this.

Router creates an index for further introspection, which at this time is not that useful but it will be relevant for chevere/router-dump, which will enable to dump routing to a file. This will suit the need of self-exposed APIs for routing defined using chevere/router.

# Learn more

Head over to the documentation and leave a star at GitHub.

Rodolfo blogging since 2012.