PHPackages yiisoft/file-router - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/file-router ActiveLibrary[Framework](/categories/framework) yiisoft/file-router =================== Convention-based file structure router 1.0.0(1y ago)7301[1 issues](https://github.com/yiisoft/file-router/issues)BSD-3-ClausePHPPHP ^8.1CI passing Since Jan 18Pushed 5mo ago13 watchersCompare [ Source](https://github.com/yiisoft/file-router)[ Packagist](https://packagist.org/packages/yiisoft/file-router)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-file-router/feed)WikiDiscussions master Synced today READMEChangelog (1)Dependencies (13)Versions (3)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii File Router =============== [](#yii-file-router) [![Latest Stable Version](https://camo.githubusercontent.com/909d2080fe888921d902460599fdbceccb61bb5f908d354027f2f79e2dc123ff/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f66696c652d726f757465722f76)](https://packagist.org/packages/yiisoft/file-router)[![Total Downloads](https://camo.githubusercontent.com/d53272d3ac9e41fb0e4dd4fbde469dc8a7e0ee9031b5a609831e75bc0e7b1db8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f66696c652d726f757465722f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/file-router)[![Build status](https://github.com/yiisoft/file-router/workflows/build/badge.svg)](https://github.com/yiisoft/file-router/actions?query=workflow%3Abuild)[![Code Coverage](https://camo.githubusercontent.com/a72768c94899eba0d7bfdbcac1226e201fcc83f186421bfa26c90b4bb954b055/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f66696c652d726f757465722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/file-router)[![Mutation testing badge](https://camo.githubusercontent.com/4622fcb322032df0c9e19124c8f1fec25ab02001a7973389cc2b2c8b2294ec29/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324666696c652d726f757465722532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/file-router/master)[![static analysis](https://github.com/yiisoft/file-router/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/file-router/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/1da3ab798877614c6f9bf17f9d6f2e94c92f1d195ae436a9f512f9b3b807fa11/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f66696c652d726f757465722f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/file-router)[![psalm-level](https://camo.githubusercontent.com/26692990be6641ebbfbd76b5708f3ff92eb8ed68a0a1190cb37d5f78271d7fce/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f66696c652d726f757465722f6c6576656c2e737667)](https://shepherd.dev/github/yiisoft/file-router) The package provides a convention-based router middleware that chooses controller based on its namespace and class name. Requirements ------------ [](#requirements) - PHP 8.1 or higher. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/file-router ``` General usage ------------- [](#general-usage) 1. Add `\Yiisoft\FileRouter\FileRouter` to the list of middlewares in your application configuration, `web/params.php`: ``` return [ 'middlewares' => [ // ... Router::class, \Yiisoft\FileRouter\FileRouter::class, // or [ 'class' => FileRouter::class, 'withNamespace()' => ['App'], 'withBaseControllerDirectory()' => ['Controller'], ], // ... ] ]; ``` 2. [Configure the file router](docs/guide/en#configuration) for your needs. > Note: `FileRouter` goes after regular `Router` to serve as a fallback in case explicitly defined route is not found. By default, the following structure of the app could be used assuming `App` points to `src` directory: ``` src Controller User Profile IndexController.php BlogController.php UserController.php IndexController.php ``` Here's how it works: - `GET /` → `IndexController::index()` - `GET /user` → `UserController::index()` - `POST /user` → `UserController::create()` - `GET /user/blog/view` → `User/BlogController::view()` - `GET /user/profile` → `User/Profile/IndexController::index()` Documentation ------------- [](#documentation) For additional information, check the following docs: - Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii File Router is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 35 — LowBetter than 77% of packages Maintenance54 Moderate activity, may be stable Popularity13 Limited adoption so far Community22 Small or concentrated contributor base Maturity48 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 530d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) ![](https://www.gravatar.com/avatar/53e5ee1dedd50f71e4aeeac2929f786cdfb400359d4776e6cd806388d0d5df2c?d=identicon)[vjik](/maintainers/vjik) --- Top Contributors [![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (23 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (15 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (1 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)") --- Tags conventionfilesystemoptionalforframeworkannouncerouterroutingstructureyii3routerroutingfile-routerconvention-routerstructure-router ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-file-router/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-file-router/health.svg)](https://phpackages.com/packages/yiisoft-file-router) ``` ### Alternatives [cakephp/cakephp The CakePHP framework 8.9k19.5M1.8k](/packages/cakephp-cakephp)[typo3/cms TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL. 1.2k1.9M122](/packages/typo3-cms)[cakephp/authentication Authentication plugin for CakePHP 1214.1M103](/packages/cakephp-authentication)[typo3/cms-core TYPO3 CMS Core 3713.2M5.1k](/packages/typo3-cms-core)[cakephp/authorization Authorization abstraction layer plugin for CakePHP 762.5M49](/packages/cakephp-authorization)[windwalker/framework The next generation PHP framework. 25740.3k1](/packages/windwalker-framework) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)