orlovtech / short-link
Laravel的链接缩短包
v0.4.0
2024-04-25 07:18 UTC
Requires
- php: ^8.1|^8.2|^8.3
- illuminate/container: ^9.0|^10.0|^11.0
- illuminate/database: ^9.0|^10.0|^11.0
Requires (Dev)
- laravel/pint: ^1.10
- mockery/mockery: ^1.0
- orchestra/testbench: ^8.0
- phpunit/phpunit: ^9.0|^10.0
README
目录
概述
一个可用于将缩短的URL添加到现有Web应用的Laravel包。
安装
要求
该包已在以下最低要求下开发和测试:
- PHP >=8.1
- Laravel >=9.0
安装包
您可以通过Composer安装此包
composer require orlovtech/short-link
发布配置和迁移
然后,您可以使用以下命令发布包的配置文件和数据库迁移:
php artisan vendor:publish --provider="OrlovTech\ShortLink\Providers\ShortLinkServiceProvider"
在此配置文件中,您可以更改要使用的前缀。默认情况下为/short/
。
迁移数据库
此包包含一个迁移,将一个新的表添加到数据库中:short_links
。要运行此迁移,只需运行以下命令
php artisan migrate
生成链接
生成新链接最快的方式是使用外观OrlovTech\ShortLink\Facades\ShortLink
,如下所示
ShortLink::generate('https://yourlink.com');
此方法将返回您的链接的缩短版本。
方法generate
还有一个可选的第二个参数singleUse
。使用此参数,您可以指定链接在首次使用后应该被删除。
因此,完整的视图可能是
ShortLink::generate( 'https://yourlink.com', singleUse: true, );
要显示准备好的链接,请使用参数default_short_url
,如下所示
$link = ShortLink::generate('https://yourlink.com'); echo config('app.url') . $link->default_short_url;
使用链接
当您准备好链接时,可以使用端点https://yourdomain.com/short/628ac418-865a
其中short
是从配置文件中的前缀
测试
要运行包的单元测试,请运行以下命令
vendor/bin/phpunit
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。