{"id":14966314,"url":"https://github.com/yiisoft/file-router","last_synced_at":"2025-10-19T09:31:06.119Z","repository":{"id":214300419,"uuid":"735928181","full_name":"yiisoft/file-router","owner":"yiisoft","description":"Convention-based file structure router","archived":false,"fork":false,"pushed_at":"2024-05-18T14:08:25.000Z","size":45,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-05-21T10:33:26.145Z","etag":null,"topics":["convention","filesystem","optionalforframeworkannounce","router","routing","structure","yii3"],"latest_commit_sha":null,"homepage":"https://www.yiiframework.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yiisoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"yiisoft","github":["yiisoft"]}},"created_at":"2023-12-26T13:37:31.000Z","updated_at":"2024-05-18T14:08:28.000Z","dependencies_parsed_at":"2024-05-03T14:31:39.611Z","dependency_job_id":"75a577c7-22e3-4dd0-adb8-71d9cba075b0","html_url":"https://github.com/yiisoft/file-router","commit_stats":{"total_commits":23,"total_committers":5,"mean_commits":4.6,"dds":"0.26086956521739135","last_synced_commit":"8bc72eed3314fb33412598199ab3c7f2df60e86a"},"previous_names":["yiisoft/file-router"],"tags_count":0,"template":false,"template_full_name":"yiisoft/package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Ffile-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Ffile-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Ffile-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Ffile-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yiisoft","download_url":"https://codeload.github.com/yiisoft/file-router/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219869543,"owners_count":16555487,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["convention","filesystem","optionalforframeworkannounce","router","routing","structure","yii3"],"created_at":"2024-09-24T13:36:12.411Z","updated_at":"2025-10-19T09:31:05.799Z","avatar_url":"https://github.com/yiisoft.png","language":"PHP","readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/yiisoft\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://yiisoft.github.io/docs/images/yii_logo.svg\" height=\"100px\" alt=\"Yii\"\u003e\n    \u003c/a\u003e\n    \u003ch1 align=\"center\"\u003eYii File Router\u003c/h1\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\n[![Latest Stable Version](https://poser.pugx.org/yiisoft/file-router/v)](https://packagist.org/packages/yiisoft/file-router)\n[![Total Downloads](https://poser.pugx.org/yiisoft/file-router/downloads)](https://packagist.org/packages/yiisoft/file-router)\n[![Build status](https://github.com/yiisoft/file-router/workflows/build/badge.svg)](https://github.com/yiisoft/file-router/actions?query=workflow%3Abuild)\n[![Code Coverage](https://codecov.io/gh/yiisoft/file-router/branch/master/graph/badge.svg)](https://codecov.io/gh/yiisoft/file-router)\n[![Mutation testing badge](https://img.shields.io/endpoint?style=flat\u0026url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Ffile-router%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/file-router/master)\n[![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)\n[![type-coverage](https://shepherd.dev/github/yiisoft/file-router/coverage.svg)](https://shepherd.dev/github/yiisoft/file-router)\n[![psalm-level](https://shepherd.dev/github/yiisoft/file-router/level.svg)](https://shepherd.dev/github/yiisoft/file-router)\n\nThe package provides a convention-based router middleware that chooses controller based on its namespace and class name.\n\n## Requirements\n\n- PHP 8.1 or higher.\n\n## Installation\n\nThe package could be installed with [Composer](https://getcomposer.org):\n\n```shell\ncomposer require yiisoft/file-router\n```\n\n## General usage\n\n1. Add `\\Yiisoft\\FileRouter\\FileRouter` to the list of middlewares in your application configuration, `web/params.php`:\n\n    ```php\n    return [\n        'middlewares' =\u003e [\n            // ...\n            Router::class,\n            \\Yiisoft\\FileRouter\\FileRouter::class,\n            // or\n            [\n                'class' =\u003e FileRouter::class,\n                'withNamespace()' =\u003e ['App'],\n                'withBaseControllerDirectory()' =\u003e ['Controller'],\n            ],\n            // ...\n        ]\n    ];\n    ```\n\n2. [Configure the file router](docs/guide/en#configuration) for your needs.\n\n\u003e Note: `FileRouter` goes after regular `Router` to serve as a fallback in case explicitly defined route\n  is not found.\n\nBy default, the following structure of the app could be used assuming `App` points to `src` directory:\n\n```\nsrc\n  Controller\n    User\n      Profile\n        IndexController.php\n      BlogController.php\n    UserController.php\n    IndexController.php\n```\n\nHere's how it works:\n\n- `GET /` → `IndexController::index()`\n- `GET /user` → `UserController::index()`\n- `POST /user` → `UserController::create()`\n- `GET /user/blog/view` → `User/BlogController::view()`\n- `GET /user/profile` → `User/Profile/IndexController::index()`\n\n\n## Documentation\n\nFor additional information, check the following docs:\n\n- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md)\n- [Internals](docs/internals.md)\n\nIf 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.\nYou may also check out other [Yii Community Resources](https://www.yiiframework.com/community).\n\n## License\n\nThe Yii File Router is free software. It is released under the terms of the BSD License.\nPlease see [`LICENSE`](./LICENSE.md) for more information.\n\nMaintained by [Yii Software](https://www.yiiframework.com/).\n\n## Support the project\n\n[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective\u0026logoColor=7eadf1\u0026labelColor=555555)](https://opencollective.com/yiisoft)\n\n## Follow updates\n\n[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)\n[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter\u0026logoColor=1DA1F2\u0026labelColor=555555?style=flat)](https://twitter.com/yiiframework)\n[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat\u0026logo=telegram)](https://t.me/yii3en)\n[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat\u0026logo=facebook\u0026logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)\n[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat\u0026logo=slack)](https://yiiframework.com/go/slack)\n","funding_links":["https://opencollective.com/yiisoft","https://github.com/sponsors/yiisoft"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Ffile-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyiisoft%2Ffile-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Ffile-router/lists"}