locomotivemtl / charcoal-contrib-redirect
提供重定向功能的炭黑管理服务。
0.1.1
2022-05-11 21:24 UTC
Requires
- php: >7.4
- ext-json: *
- charcoal-admin: >0.30.2
Requires (Dev)
- php-coveralls/php-coveralls: ^2.2
- phpunit/phpunit: ^7.1
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-09-12 02:51:16 UTC
README
用于处理从admin
界面来的路由重定向的Charcoal服务提供者。
目录
安装
首选(也是唯一支持)的方法是使用 Composer
$ composer require locomotivemtl/charcoal-contrib-redirect
依赖项
要求
PSR
- PSR-11:依赖容器通用接口。由 Pimple 实现。
服务提供者
使用_ charcoal-contrib-redirect_提供以下服务
服务
- redirection实例为
\Charcoal\Redirect\Service\Redirection
配置
重定向模块的唯一要求是在应用配置中加载模块的列表中要求模块。
{ "modules": { "charcoal/redirect/redirect": {} } }
使用
模块加载时,如果需要,将自动创建新的数据库表(charcoal_contrib_redirect_redirections
)。此表将用于存储重定向。在管理界面中,会在系统菜单下拉菜单(URL 重定向
)中添加一个新的项目。
此系统菜单项需要用户遵守"system/admin"
acl权限。
开发
要安装开发环境
$ composer install
要运行脚本(phplint,phpcs和phpunit)
$ composer test
API 文档
- 自动生成的
phpDocumentor
API文档可在以下位置找到
https://locomotivemtl.github.io/charcoal-contrib-redirect/docs/master/ - 自动生成的
apigen
API文档可在以下位置找到
https://codedoc.pub/locomotivemtl/charcoal-contrib-redirect/master/
开发依赖
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
编码风格
charcoal-contrib-redirect模块遵循Charcoal编码风格
- PSR-1
- PSR-2
- PSR-4,因此自动加载由Composer提供。
- phpDocumentor注释。
- phpcs.xml.dist和.editorconfig用于编码标准。
可以使用
composer phpcs
执行编码风格验证/强制执行。还有一个自动修复程序,可以使用composer phpcbf
。
鸣谢
许可证
Charcoal采用MIT许可证。有关详细信息,请参阅LICENSE。