rc router

¿Qué es esto?

Este es rc router . Este es un enrutador simple basado en expresiones regulares que le permite pasar variables utilizando marcadores de posición en su ruta.

¿Por qué escribir esto?

Lo hice para ejercitar mi cerebro y comprender completamente cómo funciona el enrutamiento en el espacio PHP. En lugar de simplemente leer sobre ello y asumir que sabía qué hizo qué, escribí esto para solidificar mi conocimiento.

Instalación del paquete

Simplemente use el compositor:

 composer require robert430404/rc-router

¿Cómo funciona?

Este es un paquete de compositor, por lo que depende del compositor para la carga automática de las clases. Luego crea una nueva instancia del objeto Router() y comienza a asignar sus rutas a la instancia. Una vez que haya definido sus rutas, pase el Router() al Resolver() y este manejará sus rutas.

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' / ' , function () {
    echo ' Closure Handler Test ' ;
});

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router );
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

¿Cuáles son algunas de las características?

El enrutador admite variables de URL de cadena y de números enteros y se las devuelve en una matriz. Puede ampliar esto más allá de la forma que desee. El enrutador es muy flexible en cuanto a cómo usarlo.

Puede pasar un cierre o una función de controlador con nombre a cada ruta para controlar lo que sucede cuando una ruta coincide.

Cuando no se encuentra una ruta, el solucionador genera una excepción RouteNotFoundException que le permite capturar y luego crear su controlador 404.

Ahora también puede escribir sus propios analizadores personalizados y pasarlos al solucionador para que cosas como las llamadas a Controller@Action sean mucho más fáciles y limpias de implementar.

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;
use YourProject  Routing  CustomParser ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' / ' , function () {
    echo ' Closure Handler Test ' ;
});

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router , new CustomParser ());
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

Si no pasa un analizador personalizado, el valor predeterminado será el analizador integrado.

¿Cómo funcionan los marcadores de posición?

Cuando hay marcadores de posición en su ruta, se le devuelven como una matriz a la que puede acceder en su controlador.

Tienes acceso a marcadores de posición de cadenas. Cuando defines tus rutas, usas {} para definir marcadores de posición de cadena como este:

 <?php

$ router -> request ([ ' GET ' ], ' /{placeholder} ' , function ( $ mapped ) {
    // Deal with returned data and route response here.
});

También tiene acceso a marcadores de posición de números enteros. Cuando define su ruta, usa {:i} para definir marcadores de posición enteros como este:

 <?php

$ router -> request ([ ' GET ' ], ' /{placeholder:i} ' , function ( $ mapped ) {
    // Deal with returned data and route response here.
});

Algunos ejemplos

Ruta basada en cierre simple:

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' / ' , function () {
    echo ' Closure Handler Test ' ;
});

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router );
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

Ruta simple con un controlador con nombre:

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' / ' , ' handler ' );

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router );
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

function handler ()
{
    echo ' External Handler Test ' ;
}

Ruta basada en cierre de expresiones regulares con variables:

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' /{id:i}/{post:i} ' , function ( $ mapped ) {
    echo ' <pre> ' ;
    var_dump ( $ mapped );
    echo ' </pre> ' ;

    echo ' Route Found ' ;
});

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router );
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

Ruta Regex con variables y controlador externo:

 <?php

use RcRouter  Router ;
use RcRouter  Utilities  Resolver ;
use RcRouter  Exceptions  RouteNotFoundException ;

include ' vendor/autoload.php ' ;

$ router = new Router ();

$ router -> request ([ ' GET ' ], ' /{id:i}/{post:i} ' , ' handler ' );

$ uri    = $ _SERVER [ ' REQUEST_URI ' ];    // You do not have to use globals here if you have access to a different source.
$ method = $ _SERVER [ ' REQUEST_METHOD ' ]; // You simply need to pass these (uri and method) as strings to the Resolver.

try {
    new Resolver ( $ uri , $ method , $ router );
} catch ( RouteNotFoundException $ e ) {
    echo ' 404 not found ' ;
}

function handler ( $ mapped )
{
    echo ' <pre> ' ;
    var_dump ( $ mapped );
    echo ' </pre> ' ;
    
    echo ' Route Found ' ;
}

¿Qué hay en los valores devueltos?

La variable "$mapped" devuelve una estructura como esta:

 <?php

$ mapped = [
    ' all ' => [
        ' id '   => 0 ,
        ' name ' => ' Robert '
    ],
    ' int ' => [
        ' id ' => 0
    ],
    ' string ' => [
        ' name ' => ' Robert '
    ],
];