MinasRouter is simple, fast and extremely readable for routes. Create and manage your routes in just a few steps.
Simples, rápido e MUITO funcional. MinasRouter é um componente de rotas PHP para projetos MVC! Foi feito para abstrair os verbos RESTfull
(GET, POST, PUT, PATCH, DELETE)e renderizar de forma simples e fácil no controller da aplicação.
MinasRoutertrabalha e processa todas as informações de forma isolada, facilitando o processo para o desenvolvedor e acelerando o desenvolvimento/andamento do projeto.
Simple, fast and VERY functional. MinasRouter is a PHP routes component for MVC projects! It is designed to abstract the RESTfull (GET, POST, PUT, PATCH, DELETE) verbs and render them simply and easily in the application controller.
MinasRouter works and processes all information in isolation, facilitating the process for the developer and accelerating the development/progress of the project.
- In a few minutes you can create routes for your application or api
(Yes, it really is a few minutes) - Fast and Easy middleware system
- Respect the RESTfull verbs and has great functions to deal with them
- Route customization, regex in dynamic parameters and optional parameters
- Spoofing for verbalization and data control (FormSpoofing)
- Carries dynamic parameters to controller arguments
- Easy routing groups and fast create
- It has a Request Class to control and work with route data
With two lines you start using routes!
You can check all tests done here. Enjoy!
MinasRouter is available via Composer require:
"require" {
"nicollassilva/minasrouter": "1.0.*"
}or run in terminal:
composer require nicollassilva/minasrouter- Customization
- Route Groups
- Others Methods
Para começar a usar o MinasRouter, todo o gerenciamento da navegação deverá ser redirecionado para o arquivo padrão de rotas do seu sistema, que fará todo o processo de tratamento das rotas e retornará o que foi por padrão configurado. Configure conforme os exemplos abaixo e de acordo com seu servidor.
To start using MinasRouter, all navigation management must be redirected to your system's default route file, which will do the entire route handling process and return what was configured by default. Configure according to the examples below and according to your server.
RewriteEngine On
#Options All -Indexes
# Handle Authorization Header
RewriteCond %{HTTP:Authorization} .
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
# URL Rewrite
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteRule ^(.*)$ index.php?route=/$1 [L,QSA]
### Do not use the settings below if you are using developing in a local environment, use only in production.
## WWW Redirect
#RewriteCond %{HTTP_HOST} !^www\. [NC]
#RewriteRule ^ https://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
## HTTPS Redirect
#RewriteCond %{HTTP:X-Forwarded-Proto} !https
#RewriteCond %{HTTPS} off
#RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
location / {
if ($script_filename !~ "-f"){
rewrite ^(.*)$ /index.php?route=/$1 break;
}
}To start the components:
<?php
require __DIR__ . "/../vendor/autoload.php";
use MinasRouter\Router\Route;
// The second argument is optional. It separates the Controller and Method from the string
// Example: "Controller@method"
Route::start("http://yourdomain.com", "@");
Route::get("/", function() {
// ...
});
// ... all routes here
// You will put all your routes before this function
Route::execute();Methods:
| Function | Parameter | Parameter | Parameter |
|---|---|---|---|
| get | String $uri | $callback | |
| post | String $uri | $callback | |
| put | String $uri | $callback | |
| patch | String $uri | $callback | |
| delete | String $uri | $callback | |
| match | Array $httpVerbs | String $uri | $callback |
| any | String $uri | $callback |
Example:
Route::get('/users', [\App\Controllers\User::class, 'index']);
Route::post('/users', [\App\Controllers\User::class, 'store']);
Route::put('/users/{id}', [\App\Controllers\User::class, 'update']);
Route::patch('/users/{id}', [\App\Controllers\User::class, 'update']);
Route::delete('/users/{id}', [\App\Controllers\User::class, 'delete']);
// The router allows you to register routes that respond to any HTTP verb:
Route::any('/', function() {
// ...
});
// Sometimes you may need to register a route that responds to multiple HTTP verbs:
Route::match(["GET", "POST"], "/", function() {
// ...
});Methods:
| Function | Parameter |
|---|---|
| name | String $name |
| as | String $name |
Example:
Route::get("/users/create", function() {
// ...
})->name("user.create");
Route::get("/users/2", function() {
// ...
})->as("user.show");Route::get("/", function() {
// ...
})->name("web.index");
Route::get("/user/{id}", function($id) {
echo $id;
})->name("user.show");
Route::get("/post/{id?}", function($id) {
if($id) {
echo "ID not found";
}
// ...
})->name("post.show");Methods:
| Function | Parameter | Parameter |
|---|---|---|
| where | Array $params | |
| whereParam | String $param | String $regex |
| whereNumber | String $param | |
| whereAlpha | String $param | |
| whereAlphaNumeric | String $param | |
| whereUuid | String $param |
Example:
Route::get("/user/{id}", [\App\Controllers\UserController::class, "show"])
->name("user.show")
->where(["id" => "[0-9]+"]);
// whereParam is alias of where method
Route::get("/profile/{slug}", [\App\Controllers\UserController::class, "profile"])
->name("user.profile")
->whereParam("id", "[0-9]+");
Route::get("/book/{id}", [\App\Controllers\BookController::class, "show"])
->name("book.show")
->whereNumber("id");All methods:
| Function | Parameter | ::function | ->function |
|---|---|---|---|
| namespace | String $namespace | Yes | Yes |
| prefix | String $prefix | Yes | Yes |
| name | String $name | Yes | Yes |
| middleware | String $middlewares | Yes | Yes |
Group methods can be called static way or normal, don't forget to call a function group to insert as routes inside the closure.
Examples:
Route::name("admin.")->group(function() {
Route::get("/", function() {
// admin.index
})->name("index");
});Route::prefix("admin/")->group(function() {
Route::get("/index", function() {
// http://localhost/admin/index
})->name("index");
});Route::namespace("App\Controllers")->group(function() {
Route::get("/user/{id}", ["User", "show"])->name("show");
// \App\Controllers\User
});Route::namespace("App\Controllers\Admin")
->name("admin.")
->prefix("admin")
->group(function() {
// ...
});Methods:
| Function | Parameter | Parameter | Parameter |
|---|---|---|---|
| redirect | String $uri | String $redirect | Int $statusCode = 302 |
| permanentRedirect | String $uri | String $redirect |
Example:
// Returns 302 status code by default.
Route::redirect("/here", "/there");
Route::redirect("/here", "/there", 301);
// permanentRedirect always returns 301
Route::permanentRedirect("/here", "/there");
// You can return an existing route
Route::redirect("/index", "web.index");OBS: Tenha cuidado caso queira redirecionar para uma rota existente, se nela conter argumentos dinâmicos, ela retornará todo o regex e irá causar erro.
Be careful you redirect to an existing route, because if it has dynamic arguments, it will return the entire regex and error returned.