rc router

これは何ですか？

これはrc routerです。これは単純な正規表現ベースのルーターで、ルート内でプレースホルダーを使用して変数を渡すことができます。

なぜこれを書くのか?

頭を柔らかくし、PHP 空間でルーティングがどのように機能するかを完全に理解するためにこれを行いました。ただ読んで、何が何をするのか知っていると思い込むのではなく、知識を定着させるためにこれを書きました。

パッケージのインストール

単純にコンポーザーを使用します。

 composer require robert430404/rc-router

仕組みは?

これはコンポーザー パッケージであるため、クラスの自動ロードをコンポーザーに依存します。次に、Router() オブジェクトの新しいインスタンスを作成し、そのインスタンスへのルートの割り当てを開始します。ルートを定義したら、Router() を Resolver() に渡すと、Resolver() がルートを処理します。

 <?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 ' ;
}

特徴にはどのようなものがありますか?

ルーターは文字列と整数の両方の URL 変数をサポートし、それらを配列で返します。これを任意の方法でさらに拡張できます。ルーターは使い方が非常に柔軟です。

クロージャまたは名前付きハンドラー関数を各ルートに渡して、ルートが一致したときに何が起こるかを制御できます。

ルートが見つからない場合、RouteNotFoundException がリゾルバーからスローされ、これをキャッチして 404 ハンドラーを作成できるようになります。

また、独自のカスタム パーサーを記述してリゾルバーに渡すこともできるようになり、Controller@Action 呼び出しなどをより簡単かつクリーンに実装できるようになりました。

 <?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 ' ;
}

カスタム パーサーを渡さない場合、デフォルトで組み込みパーサーが使用されます。

プレースホルダーはどのように機能しますか?

ルート内にプレースホルダーがある場合、それらはハンドラーでアクセスできる配列として返されます。

文字列プレースホルダーにアクセスできます。ルートを定義するときは、次のように {} を使用して文字列プレースホルダーを定義します。

 <?php

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

整数プレースホルダーにもアクセスできます。ルートを定義するときは、{:i} を使用して次のように整数プレースホルダーを定義します。

 <?php

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

いくつかの例

単純なクロージャベースのルート:

 <?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 ' ;
}

名前付きハンドラーを使用した単純なルート:

 <?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 ' ;
}

変数を使用した正規表現クロージャーベースのルート:

 <?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 ' ;
}

変数と外部ハンドラーを使用した正規表現ルート:

 <?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 ' ;
}

戻り値には何が含まれますか?

「$mapped」変数は次のような構造を返します。

 <?php

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