ruta

Ruta

Eine leichte HTTP -Routing -Bibliothek für PHP. (WIP)

Merkmale

• HTTP -Statuscodes
• HTTP -Methoden
• HTTP -Header
• HTTP -Anfragen
  • Behandeln Sie multipart/form-data -Anforderungsdaten
  • Behandeln Sie x-www-form-urlencoded -Anforderungsdaten
  • Verwandten Sie application/xml -Anforderungsdaten
  • Verwandten Sie application/json -Anforderungsdaten
  • query -URI -Anforderungsparams behandeln
  • path und headers
• HTTP -Antworten
  • HTML-, JSON-, XML- oder Textantworten
  • HTTP -Umleitungen
• HTTP -Routing
  • Routen mit Platzhalterargumenten: /abc/{some}
  • Behandeln Sie mehrere gültige HTTP -Methoden um
  • Behandeln Sie eine gültige HTTP -Methode
  • Behandeln Sie keine Übereinstimmungen (404s)
  • Unterstützen Sie einen Rückruf oder einen Klassen-/Methodenstil
  • Optionale und bestellungsunempfindliche Argumente zu Rückruf- oder Klassen-/Methodenhandlern
  • Reguläre Ausdrücke Unterstützung: /abc/regex(id=^[0-9]+$)
  • Optionale Routenargumente: /abc/{some?}
  • Fallback -Routen
  • Route Cache
• Middlewares
  • Überprüfen oder filtern Sie gültige Anforderungen vor dem Routing
  • Überprüfen oder filtern Sie gültige Anfragen nach dem Routing

Siehe Leap Micro-Framework basierend auf Ruta.

Anforderungen

PHP 8.0 oder neuer.

Installieren

Installieren Sie über Komponist

composer require joseluisq/ruta:dev-master

Verwendung

 <?php

declare (strict_types= 1 );

require ' vendor/autoload.php ' ;

use Ruta  Header ;
use Ruta  Method ;
use Ruta  Ruta ;
use Ruta  Request ;
use Ruta  Response ;
use Ruta  Status ;

// 1. Callback style

// NOTE: `Request`, `Response`, `array` (slug arguments) are passed to the callback.
// However they are optional and their order can be modified. See more examples below.

Ruta:: get ( ' /home/hola ' , function ( Request $ req , Response $ res ) {
    $ res -> json ([
        ' host ' => $ req -> header (Header::Host),
        ' headers ' => $ req -> headers (),
    ]);
});
Ruta:: get ( ' /home/hola/redirect ' , function ( Response $ res ) {
    $ res -> redirect ( ' /home/aaa/some/bbb ' );
});
Ruta:: get ( ' /reg/regex(id=^[0-9]+$)/exp ' , function ( Response $ res , array $ args ) {
    $ res -> json ([ ' args ' => $ args ]);
});
Ruta:: post ( ' /home/{path3}/some2 ' , function ( Response $ res ) {
    $ res -> json ([ ' post_data ' => 11010101010 ]);
});

Ruta:: some ( ' /home/some ' , [Method:: POST , Method:: PUT ], function ( Request $ req , Response $ res ) {
    $ res -> json ([ ' only ' => $ req -> method ()]);
});

Ruta:: any ( ' /home/methods ' , function ( Request $ req , Response $ res ) {
    $ res -> json ([ ' method ' => $ req -> method ()]);
});

Ruta:: post ( ' /home/{path} ' , function ( Response $ res ) {
    $ res
        -> header ( ' X-Header-One ' , ' Header Value 1 ' )
        -> header ( ' X-Header-Two ' , ' Header Value 2 ' )
        -> json ([ ' some_data ' => 223424234 ]);
});

// 2. class/method style
class HomeCtrl
{
    public function index ( Request $ req , Response $ res , array $ args )
    {
        // 2.1 $args contains route placeholder values
        if ( array_key_exists ( ' path1 ' , $ args )) {
            // do something...
        }

        // 2.2. Get data provided via `multipart/form-data` 
        $ data = $ req -> multipart ();
        // 2.3. Get all headers
        $ data = $ req -> headers ();
        // 2.4. Get a single header
        $ data = $ req -> header ( " Host " );
        // 2.5. Get data provided via `application/x-www-form-urlencoded` 
        $ data = $ req -> urlencoded ();
        // 2.6. Get data provided via `application/json`
        $ data = $ req -> json ();
        // 2.7. Get data provided via `application/xml`
        $ data = $ req -> xml ();
        // 2.8. Get query data
        $ data = $ req -> query ();

        $ res -> json ([ ' data ' => ' Message from a class! ' ]);
    }

    // Custom 404 reply
    public function not_found ( Response $ res )
    {
        $ res
            -> status (Status::NotFound)
            -> text ( " 404 - Page Not Found! " );
    }
}

Ruta:: get ( ' /home/{path1}/some/{path2} ' , [HomeCtrl::class, ' index ' ]);

// 3. Handle 404 not found routes
Ruta:: not_found ([HomeCtrl::class, ' not_found ' ]);

Codebeispiel

Datei: Beispiel/nginx/public/index.php

 # Or run example using Docker + Nginx server
make compose-up

 # Run example using the PHP built-in server
make container-dev

Navigieren Sie nun zum Beispiel zu http: // localhost: 8088/home/Hola

Beiträge

Senden Sie eine Pull -Anfrage oder stellen Sie ein Problem ein.

Beiträge

Sofern Sie nicht ausdrücklich etwas anderes angeben, ist ein Beitrag, der absichtlich zur Aufnahme in die aktuelle Arbeit von Ihnen eingereicht wird, wie in der Apache-2.0-Lizenz definiert, ohne zusätzliche Bedingungen wie nachstehend beschriebene lizenzierte lizenziert.

Senden Sie gerne eine Pull -Anfrage oder ein Problem.

Lizenz

Diese Arbeit wird hauptsächlich unter den Bestimmungen der MIT -Lizenz und der Apache -Lizenz (Version 2.0) verteilt.

© 2021-Present Jose Quintana