Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/file-router
Convention-based file structure router
https://github.com/yiisoft/file-router
convention filesystem optionalforframeworkannounce router routing structure yii3
Last synced: 3 months ago
JSON representation
Convention-based file structure router
- Host: GitHub
- URL: https://github.com/yiisoft/file-router
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2023-12-26T13:37:31.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-05-18T14:08:25.000Z (7 months ago)
- Last Synced: 2024-05-21T10:33:26.145Z (7 months ago)
- Topics: convention, filesystem, optionalforframeworkannounce, router, routing, structure, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com
- Size: 43.9 KB
- Stars: 5
- Watchers: 16
- Forks: 1
- Open Issues: 1
-
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
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii File Router
[![Latest Stable Version](https://poser.pugx.org/yiisoft/file-router/v)](https://packagist.org/packages/yiisoft/file-router)
[![Total Downloads](https://poser.pugx.org/yiisoft/file-router/downloads)](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://codecov.io/gh/yiisoft/file-router/branch/master/graph/badge.svg)](https://codecov.io/gh/yiisoft/file-router)
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=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)
[![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://shepherd.dev/github/yiisoft/file-router/coverage.svg)](https://shepherd.dev/github/yiisoft/file-router)
[![psalm-level](https://shepherd.dev/github/yiisoft/file-router/level.svg)](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
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/file-router
```## General usage
1. Add `\Yiisoft\FileRouter\FileRouter` to the list of middlewares in your application configuration, `web/params.php`:
```php
return [
'middlewares' => [
// ...
\Yiisoft\FileRouter\FileRouter::class,
// or
[
'class' => FileRouter::class,
'withNamespace()' => ['MyApp\\Package1'],
'withDefaultControllerName()' => ['Default'],
],
// ...
]
];
```2. Configure the router for your needs.
## 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
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
[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
## Follow updates
[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)