defmost/laravel-url-shortener

Laravel中的强大URL缩短工具

v1.0.0 2023-07-04 06:12 UTC

This package is auto-updated.

Last update: 2024-09-06 06:37:04 UTC


README

这是一个从 https://github.com/LaraCrafts/laravel-url-shortener 分支出来的项目,仅为了保持该项目活跃,增加了对Laravel 9+的支持,提供了强大的URL缩短工具

安装

您可以使用Composer轻松安装此包,只需运行以下命令

composer require defmost/laravel-url-shortener

需求

此包有以下需求

  • PHP 8.1或更高版本
  • Laravel 9.0或更高版本

使用方法

可以从容器中用两种方式检索缩短器

$shortener = app('url.shortener');
// or...
$shortener = url()->shortener();

一旦您有了缩短器的实例,您就可以缩短您的URL

// This will return your shortened URL as a string
$shortener->shorten(...);

// This will return a promise which will resolve to your shortened URL
$shortener->shortenAsync(...);

// You can also call shortening from Laravel's url component directly
url()->shorten(...);

// or...
app('url')->shorten(...);

// or even...
app('url.shortener')->shorten(...);

此包依赖于Guzzle的promise库来进行异步缩短,有关更多信息,请参阅他们的文档

您还可以使用依赖注入将缩短器注入到方法中

class MyController extends Controller
{
    public function myFunction(ShortenerManager $shortener)
    {
        $shortener->shorten(...);
    }
}

缩短器公开了以下方法

更改驱动程序

您可以通过在环境文件中设置URL_SHORTENER_DRIVER={driver}或通过发布配置文件并直接更改它来更改默认驱动程序。

添加自己的驱动程序

类似于Laravel的核心组件,您可以为此包添加自己的驱动程序。您可以通过在应用程序的中央位置添加以下代码来实现(最好是服务提供者)。

public function boot(ShortenerManager $shorteners)
{
    $shorteners->extend('my_driver', function ($app, $config) {
       // Return your driver instance here
    });
}

一旦您注册了驱动程序,就可以像调用任何其他驱动程序一样调用它。

如果您编写了一个可能对其他人有用的自定义驱动程序(例如公共在线缩短器服务),请考虑通过拉取请求将其添加到包中。

可用驱动程序

以下是可用驱动程序的列表及其各自的规范

Bit.ly

网站

此驱动程序在Bit.ly的API上运行,目前仅支持API版本4。API需要访问令牌,目前仅支持通用访问令牌。您可以从Bit.ly个人资料中获取此类令牌。如果您有付费的Bit.ly帐户,您还可以设置缩短URL的域名。

Firebase Dynamic Links

网站

此驱动程序在Firebase的API上运行。API需要访问令牌、URI前缀和后缀。您可以在Firebase控制台中访问这些信息。令牌可在项目设置下找到,称为“Web API密钥”,而前缀可以在动态链接菜单下定义和访问。

后缀可以具有SHORTUNGUESSABLE的值。

重要!通过API创建的链接在Firebase控制台中不可见。它们只能通过Analytics REST API访问。

Is.gd / V.gd

网站

此驱动程序支持is.gdv.gd,通过它们各自的API。当启用链接预览时,将使用v.gd,否则将使用is.gd。

Ouo.io

网站

此驱动程序使用Ouo.io API,需要访问令牌。API允许通过广告进行URL货币化,并通过其仪表板提供分析。

Polr

网站

此驱动程序使用Polr API。该API需要访问令牌和URI前缀。

Shorte.st

网站

此驱动程序使用Shorte.st API,需要访问令牌。此API支持您的URL货币化,并通过其仪表板提供对您流量的洞察。

TinyURL

网站

此驱动程序在TinyURL API上运行,无需额外设置。此驱动程序是包的默认设置。

变更日志

有关最近版本中更改的更多信息,请参阅变更日志

安全

如果您发现任何与安全相关的问题,请通过电子邮件联系作者之一,而不是使用问题跟踪器。您可以在composer.json中找到作者电子邮件。

贡献

有关详细信息,请参阅贡献指南

致谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件