ricwein / shurl
此包已被弃用且不再维护。未建议替代包。
基于PHP的URL缩短器
v1.0
2017-08-20 11:59 UTC
Requires
- php: >= 7.0.0
- hashids/hashids: ^2.1@dev
- klein/klein: dev-master
- leafo/scssphp: dev-master
- monolog/monolog: ^2.0@dev
- phpfastcache/phpfastcache: ^6.0
- symfony/console: 3.4.x-dev
- symfony/yaml: ^3.2
- usmanhalalit/pixie: ^2.0
Requires (Dev)
- phpunit/phpunit: ^6.4@dev
This package is auto-updated.
Last update: 2023-09-29 01:52:38 UTC
README
另一个基于PHP的URL缩短器。
安装
项目
要创建新的shurl实例,可以通过composer初始化项目,只需运行以下命令
composer create-project ricwein/shurl -s dev
数据库
初始化数据库结构可以通过两种方式完成。或者运行来自resources/database/database.sql的静态查询,或者使用init
命令行工具。
此工具需要您首先设置所需的数据库配置!这可以通过配置中描述的方式进行。需要一个有效的数据库用户,并且需要:数据库已存在,或者有创建新数据库的权限。
bin/shurl init
由于此工具认可您的数据库配置,生成的数据库结构是可定制的!使用表前缀、自定义字符集,甚至另一个数据库名称!
配置
默认配置存储在src/Config/Config.php中的$__config
数组中,但可以通过在config/config.yml
中添加配置文件来覆盖。它应该具有以下格式
--- database: username: usernamehere prefix: shurl_ cache: enabled: true
这样就可以覆盖每个单独的设置。
您可以将示例文件复制过来开始使用
cp config/example.config.yml config/config.yml
rootURL
对于某些功能,shurl需要知道您的Web服务器的域名和shurl的路径。此URL可以在描述的配置文件中设置
--- rootURL: https://fancy.url
添加新URL
使用捆绑的CLI工具添加新URL到缩短服务器。只需运行bin/shurl url:add
,然后按照说明操作。更多信息请参阅bin/shurl url:add --help
。
删除URL
从列表中删除URL与添加一样简单。在命令行中执行bin/shurl url:remove
即可完成。
列出可用的URL
所有当前可用的URL列表可以通过bin/shurl url:show
访问
路由
shurl支持多种不同的路由。
- / 根目录显示欢迎信息
- /{slug} 重定向到给定的URL
- /preview/{slug} 显示解析的URL预览
- /api/{slug} 提供一个简单的JSON API(
GET
方法),提供对解析URL的访问
[{ "slug": "shurl", "original": "https:\/\/s.ricwein.com" }]