README

Laravel 强大的 URL 缩短工具

安装
使用
- 更改驱动程序
- 添加自定义驱动程序
可用驱动程序
- Bit.ly
- Firebase 动态链接
- Is.gd
- Ouo.io
- Polr
- Shorte.st
- TinyURL
- V.gd
变更日志
安全
贡献
致谢
许可

安装

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

composer require laracrafts/laravel-url-shortener

要求

此包有以下要求

PHP 7.1 或更高版本
Laravel 5.1 或更高版本

Laravel 5.5+

如果您使用 Laravel 5.5 或更高版本，那就行了。现在您可以使用此包，继续到使用部分。

Laravel 5.1-5.4

如果您正在使用较旧版本的 Laravel，请将包的服务提供者注册到您的应用程序中。您可以通过将以下行添加到您的 config/app.php 文件中来实现这一点

'providers' => [
   ...
   LaraCrafts\UrlShortener\UrlShortenerServiceProvider::class,
   ...
],

使用

缩略器可以通过两种方式从容器中检索

$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 的承诺库进行异步缩短，有关更多信息，请参阅他们的文档

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

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 动态链接

网站

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

后缀可以是 SHORT 或 UNGUESSABLE 的值。

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

Is.gd / V.gd

网站

此驱动程序支持通过各自的API使用 is.gd 和 v.gd。当启用链接预览时，将使用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上运行，无需额外设置。此驱动程序是包的默认设置。

变更日志

有关最近版本中更改的信息，请参阅 CHANGELOG。

安全

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

wangta69 / laravel-url-shortener

维护者

详情