ruta

ルタ

PHP用の軽量HTTPルーティングライブラリ。 （WIP）

特徴

• HTTPステータスコード
• HTTPメソッド
• HTTPヘッダー
• HTTPリクエスト
  • multipart/form-data要求データを処理します
  • x-www-form-urlencodedリクエストデータを処理します
  • application/xml要求データを処理します
  • application/jsonリクエストデータを処理します
  • query uriリクエストパラメーションを処理します
  • アクセス要求pathとheaders
• HTTP応答
  • HTML、JSON、XMLまたはテキスト応答
  • HTTPリダイレクト
• HTTPルーティング
  • プレースホルダーの引数があるルート： /abc/{some}
  • 複数の有効なHTTPメソッドを処理します
  • 有効なHTTPメソッドを処理します
  • 一致しないルート（404）
  • コールバックまたはクラス/メソッドスタイルをサポートします
  • コールバックまたはクラス/メソッドハンドラーに関するオプションおよび順序感受性の引数
  • 正規表現サポート： /abc/regex(id=^[0-9]+$)
  • オプションのルート引数： /abc/{some?}
  • フォールバックルート
  • ルートのキャッシュ
• ミドルウェア
  • ルーティング前に有効なリクエストを検査またはフィルタリングします
  • ルーティング後に有効なリクエストを検査またはフィルタリングします

Rutaに基づいたLeap Micro-Frameworkを参照してください。

要件

PHP 8.0以降。

インストール

Composer経由でインストールします

composer require joseluisq/ruta:dev-master

使用法

 <?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 ' ]);

コードの例

ファイル：example/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

次に、たとえばhttp：// localhost：8088/home/holaに移動します

貢献

プルリクエストを送信したり、問題を提出したりしてください。

貢献

明示的に特に述べない限り、Apache-2.0ライセンスで定義されているように、お客様による現在の仕事に含めるために意図的に提出された貢献は、追加の条件なしで、以下に説明するようにデュアルライセンスを取得するものとします。

プルリクエストや問題をお気軽に送信してください。

ライセンス

この作業は、主にMITライセンスとApacheライセンス（バージョン2.0）の両方の条件の下で配布されます。

©2021-Present Jose Quintana