Download the PHP package tanahiro2010/slim-router-dsl without Composer
On this page you can find all versions of the php package tanahiro2010/slim-router-dsl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tanahiro2010/slim-router-dsl
More information about tanahiro2010/slim-router-dsl
Files in tanahiro2010/slim-router-dsl
Package slim-router-dsl
Short Description Slim Original DSL for router
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package slim-router-dsl
Slim Router DSL
Slim Framework のルーティングを「登録処理」ではなく「宣言的なルートツリー」として定義し、Routes::deploy() によってSlimへ展開する軽量DSLライブラリです。
このコードだけで、/api 配下・Auth Middleware適用・usersエンドポイント群・deploy() によるSlimへの登録、という構造が一目でわかります。
詳細なドキュメントは /example を参照してください。
インストール
なぜ使うか
Slim標準のルーティングは以下のように命令的に登録します。
ルート数やネストが増えると、構造と登録処理が混在し、Middlewareの適用範囲も視覚的に把握しにくくなります。
Slim Router DSLでは、ルーティングをまずデータ構造として定義し、deploy() によって初めてSlimへ登録します。DSL定義の時点ではSlimへの副作用は一切発生しません。
基本API
HTTP Route
Handlerには Callable、[Controller::class, 'method']、Invokable Classのいずれも指定できます。Controllerの解決は行わずSlim / Containerに委ねます。
Group
Groupはネスト可能で、パスは子ノードへ継承されます。/api + /users、/api/ + /users、/api + users はいずれも /api/users に正規化されます。
Middleware
MiddlewareはGroupと自由にネストでき、Middleware情報は子ノードへ継承されます。DSL上で記述した順序（外側 → 内側）と実行順序が一致するように deploy() 時に登録順が調整されます。
Route単位のFluent Middleware / Route Name
HttpRoute はimmutableなので、middleware() / name() はどちらも新しいインスタンスを返します。元のインスタンスは変更されません。Route単位のmiddlewareは、GroupやMiddlewareから継承したmiddlewareより後（Handlerに最も近い位置）に実行されます。name() で指定した名前は deploy() 時にSlimの setName() に渡されます。
Metadata
meta() もimmutableな Fluent APIで、複数回呼び出すと後から指定したキーが上書きされる形でマージされます（Group/Middleware単位での継承は行わず、Route単位のみ）。付与したメタデータは compile()/toArray() の結果や filter() から参照できます。
Route Dump / toArray() / compile()
列は dump(bool $showMiddleware = true, bool $showName = true, bool $showHandler = false) で調整できます。
compile() は同じ内容を CompiledRoute[]（methods/path/handler/middleware/name/metadata を持つreadonlyオブジェクト）として返す、より低レベルなAPIです。toArray()/dump()/後述のInspection APIはすべてこの compile() の結果を利用しています。
いずれもSlimへdeploy()する前に呼び出せる、Slimに依存しないルートツリーの解析APIです。
Route Inspection
Validation
deploy() 前に呼び出すことで、以下を検出できます（deploy() は自動でvalidateしません、明示的に呼び出してください）。
- 同一Method + Pathの重複定義 →
DuplicateRouteException - 同一Route Nameの重複定義 →
DuplicateRouteNameException
いずれも最初に見つかった時点でthrowされます（method+pathの重複チェックが先、name重複チェックが後）。
Route::resource()
展開結果(Handlerはそれぞれ [UserController::class, '<action>']):
only/except で生成対象を絞り込めます(同時指定は InvalidRouteException)。
Route::controller()
Route::controller() の配下では、Handlerに文字列を渡すと [UserController::class, '<文字列>'] として解決されます。Closureや [Class, method] 配列など文字列以外のHandlerは影響を受けません。また Route::controller() の外側で文字列Handlerを使う場合(Slimのコンテナ名解決など)は従来通り変化しません。Route::group()/Route::middleware() と自由にネストできます。
deploy()
Routes の構築時点ではルートツリーをメモリ上に構築するだけで、deploy(App $app) を呼んだ時点で初めてSlimへ登録されます。
CLI
--bootstrap で指定したPHPファイルが Routes インスタンスを return する必要があります(未指定時はカレントディレクトリの ./routes.php を探索)。
routes コマンドはSlimの App を一切生成せず Routes::compile()/dump()/toArray()(v1.1)のみを利用するため、DIコンテナ全体を起動せずにルート一覧を確認できます。validate コマンドは Routes::validate()(v1.1)を実行し、問題があればexit code 1で終了します。
例外
すべてのライブラリ独自例外は RouterDslException（RuntimeException を継承）を共通の基底とし、一括catchできます。
InvalidRouteNodeException:Routes/ Group / Middleware の children にRouteNode以外が渡された場合InvalidRouteException:Route::map()に空のmethod配列が渡された場合InvalidMiddlewareException:Route::middleware()に空のmiddleware配列が渡された場合DuplicateRouteException:Routes::validate()が同一Method + Pathの重複を検出した場合DuplicateRouteNameException:Routes::validate()が同一Route Nameの重複を検出した場合
v1 Scope
v1.0では以下を提供しました（MVP Scope + Optional Scope）。
Routes/Routes::deploy()/Routes::toArray()/Routes::dump()Route::get/post/put/patch/delete/options/head/map/any/group/middleware()HttpRoute::middleware()/HttpRoute::name()（Fluent API、共にimmutable）- Nested Group / Nested Middleware / Multiple Middleware / Route-level Middleware
- Slim 4 Compiler、Path正規化、Middleware順序保持、Route Name
- 基本的なバリデーションと例外
v1.1では以下を追加しました。
Routes::compile()—CompiledRoute[]のPublic API化Routes::findByName()/filterByMethod()/findByPath()/filterByMiddleware()Routes::validate()（重複Route / 重複Route Nameの検出）dump()のテーブル形式化(NAME/MIDDLEWARE列、オプションでHANDLER列)
v1.2では以下を追加しました。
HttpRoute::meta()— Route単位の任意メタデータ付与（Fluent API、immutable）CompiledRoute::$metadata/toArray()のmetadataキーRoutes::filter()— 任意の述語でCompiledRouteを絞り込み
v1.3では以下を追加しました。
Route::resource()— 標準的なCRUD Routeの一括生成(only/except対応)Route::controller()— 同一Controllerを使うRoute群でController class記述を省略
v1.4では以下を追加しました。
- CLI (
vendor/bin/router-dsl routes/validate) —--bootstrap/--json/--method=/--name=対応、Slim Appなしでルート一覧・検証が可能
詳細は slim-router-dsl-prd.md を参照してください。
動作要件
- PHP >= 8.2
- Slim Framework 4.x
テスト
License
MIT License. 詳細は LICENSE を参照してください。
