thallesdella / factory-router
Composer 组件模型
Requires
- php: ^7.3
- coffeecode/router: 1.0.7
Requires (Dev)
- phpunit/phpunit: 8.5.2
- squizlabs/php_codesniffer: 3.*
This package is auto-updated.
Last update: 2024-09-29 05:49:25 UTC
README
Factory Router 是一个简单的组件,帮助您创建系统路由。使用路由引擎 Router,它将路由管理路由到您选择的某个类。
特点
- 简单安装
- 易于使用
- 适用于 composer 且兼容 PSR-2
安装
Factory Router 通过 composer 提供
"thallesdella/factory-router": "^1.0.*"
或者执行
composer require thallesdella/factory-router
文档
FactoryRouter
构建对象
-
FactoryRouter::class(string $projectUrl, string $projectRoot, string $namespace)
- $projectUrl: 项目的基准 URL
- $projectRoot: 项目的根路径
- $namespace: 控制器的默认命名空间
注意:命名空间可以在运行时更改。
添加文件或文件夹
-
FactoryRouter::addFile(string $file): FactoryRouter
- $file: 相对于项目根的文件路径
-
FactoryRouter::addDir(string $dir): FactoryRouter
- $dir: 相对于项目根的目录路径
获取 Router 对象
- FactoryRouter::build(): Router
路由
-
Routes::class(Router $router, string $controllerName)
- $router: Router 对象
- $controllerName: 控制器名称
-
Routes::namespace(?string $ns): Routes
- $ns: 新的命名空间
-
Routes::group(?string $group): Router
- $group: 组名称
-
Routes::get(string $route, string $name): void
- $route: 路由路径
- $name: 路由别名
-
Routes::post(string $route, string $name): void
- $route: 路由路径
- $name: 路由别名
-
Routes::put(string $route, string $name): void
- $route: 路由路径
- $name: 路由别名
-
Routes::delete(string $route, string $name): void
- $route: 路由路径
- $name: 路由别名
创建 Router 管理器类
创建一个类并扩展 Routes 类。
use CoffeeCode\Router\Router; use ThallesDella\FactoryRouter\Routes; class Foo extends Routes { public function __contruct(Router $router){ parent::__construct($router, 'Bar'); } }
必须创建一个名为 updateRouter 的方法,其签名如下
public function updateRouter(): Router;
有关使用方法的更多详细信息,请参阅组件目录中的示例文件夹。
贡献
请参阅 CONTRIBUTING 以获取详细信息。
支持
如果您发现与安全相关的问题,请发送电子邮件至 thallesdella@gmail.com,而不是使用问题跟踪器。
感谢
鸣谢
- Thalles D. Koester (开发者)
- 所有贡献者 (了不起的人们)
许可证
MIT 许可证 (MIT)。请参阅 许可证文件 以获取更多信息。