README

AltaRouter is a fork of AltoRouter, light weighted package adding route attributes capabilities and efficient route caching and checking mechanism

Usage:

use Route;

// map homepage controller
#[Route(method: 'get', route: 'home', name: 'home-page')]
public function home()
{
    ...
}

// Route matching
// Optional parameters 'route' and 'httpMethod', match could fetch them directly from $_SERVER

$match = $this->match($route, $httpMethod);
...

AltaRouter Features

Routes created automatically by AltaRouter using attribute mechanism
Routes cached in a php file, this file is rebuild if the controller file of the requested route more recent than cache file
Instead of multiple 'map' call, a single include with all routes in an array is done at init

And of course, as AltoRouter

Can be used with all HTTP Methods
Dynamic routing with named route parameters
Reversed routing
Flexible regular expression routing (inspired by Sinatra)
Custom regexes

This doc covers only AltaRouter usage with php attributes, refer to the AltoRouter documentation for everything else

Getting started

You need PHP >= 8.0 to use AltoRouter.

AltaRouter installation

AltaRouter respect PSR4 autoloading rules. The best way to include AltaRouter in your project is to use composer

composer require altarouter/altarouter

Follow Rewrite all requests to AltoRouter explanations to redirect http requests to altarouter

Route mapping

Route mapping could be done using 'map' method, see Map your routes for usage explanations

AltaRouter provides you the capability to declare routes on top of the controller:

#[Route(method: method, route: url, name: routeName)

Description of parameters:

method

(string) : 'get', 'post', 'put', 'delete', ...
(array) : ['get', 'post']

route:

(string) : url of the route, like 'account/rights'

name:

(string optional) : name of the route. The route name is mandatory if you want to build later url routes for buttons or anchors

Match requests amon defined routes

The route matching is identical at those defined in Altorouter docs : Match requests and Process the request your preferred way

Contributors

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

altarouter/altarouter

包简介

关键字：

README 文档