Router @MinasRouter

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.

MinasRouter trabalha 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.

Highlights @MinasRouter

• 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!

Application example

Maybe you are a person who learns by watching, you can access the example folder, which contains an folders architecture example of how we use MinasRouter.

Tests

You can check all tests done here. Enjoy!

Installation

MinasRouter is available via Composer require:

"require" {
    "nicollassilva/minasrouter": "^1.0"
}

or run in terminal:

composer require nicollassilva/minasrouter

Documentation

1. Configuration

• Redirect to Public Folder

• Public Folder Configuration

• Apache
• Nginx

2. Routes

• My first Route
• RESTfull Verbs

• Customization

• Named Routes
• Dynamic Parameters (Required and Optional)
• Validating a Dynamic Parameter

• Middlewares

• Set Global Middlewares
• Attach in a route
• Delete a middleware

• Route Groups

• All Methods
• Named Group
• Prefixed Group
• Default Namespace Group
• Default Middleware Group
• Nested Group Methods

• Others

• Route Redirect
• Route with Individual Middleware in Group
• Route with Different Name in Group
• Fallback Routes

3. Request Route

• Introduction

• Methods

• Request Path
• Request URL
• Request Headers
• Request IP Address
• Retrieving Data
• Request Method

Introduction

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.

Redirect to Public Folder

RewriteEngine on
Options All -Indexes

RewriteCond %{HTTPS} on
RewriteCond %{HTTP_HOST} (www\.)?localhost
RewriteRule (.*) https://%{HTTP_HOST} [L,R=301]

RewriteCond %{REQUEST_URI} !public/
RewriteRule (.*) /public/$1 [L]

apache

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]

nginx

location / {
  if ($script_filename !~ "-f"){
    rewrite ^(.*)$ /index.php?route=/$1 break;
  }
}

The first Route

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();

RESTfull Verbs

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() {
    // ...
});

Named routes

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");

Dynamic parameters (required and optional)

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) {
        // ...
    }
    
    // ...
})->name("post.show");

Validating a dynamic parameter

Methods:

| Function | Parameter | Parameter | |:-----------------:|:-------------:|