README

vinelab/url-shortener 是一个与PHP框架无关的包，可以轻松缩短您的URL，支持您喜欢的URL缩短提供者，例如（Bit.ly, Goo.gl, Ow.ly）。

URL缩短提供者是在线服务，可以将长URL压缩成更少的字符，以便更容易分享、推文或通过电子邮件发送。

该包需要PHP 5.4+，并捆绑了Laravel 5 Facade和Service Provider，以简化可选框架集成，并遵循FIG标准PSR-4，以确保共享PHP代码之间的高互操作性，并完全单元测试。

亮点

• 支持Bit.ly

安装

安装此包的推荐方式是通过 Composer。

通过Composer

A. 运行以下composer命令

	composer require vinelab/url-shortener:*

B. 或者 手动将包添加到您的 composer.json 并运行 composer update。

    {
        "require": {
            "vinelab/url-shortener": "*"
        }
    }

集成

url-shortener 是框架无关的，因此可以轻松集成，无论是本地还是使用您喜欢的框架。

Laravel

url-shortener 包为Laravel 5提供可选支持，并捆绑了Service Provider以简化集成。

正确安装包后，只需遵循说明。

.1. 在您的 config/app.php 中注册服务提供者

    'providers' => array(
        ...
		'Vinelab\UrlShortener\UrlShortenerServiceProvider'
    ),

服务提供者将自动将 Vinelab\UrlShortener\Shorten 类别别名为，因此您可以在应用程序的任何地方轻松使用 Shorten 门面。

.2. 发布配置文件

php artisan vendor:publish --provider ='Vinelab\UrlShortener\UrlShortenerServiceProvider'

配置

.1. 打开 url-shortener.php 并选择您的默认提供者

	'default' => 'bitly',

.2. 然后添加您的提供者令牌

        'bitly' => [
            'domain' => 'https://api-ssl.bitly.com',
            'endpoint' => '/v3/shorten',
            'token' => 'YOUR-TOKEN-HERE',
        ],

注意：非常建议不要将您的令牌（任何敏感数据）添加到配置文件中，而是将其引用到 .env 变量。

为此

1. 将 'token' => 'YOUR-TOKEN-HERE', 替换为 'token' => env('BITLY_TOKEN'),

2. 打开您的 .env 文件，并添加令牌变量及其值： BITLY_TOKEN=YOUR-TOKEN-HERE。

3. 将变量 BITLY_TOKEN= 添加到 .env.example 以供其他开发者使用。

用法

与Laravel一起使用

最简单的方法是使用 Shorten 门面。

$long_url = 'http://testing.tst/something/12345/something-else/54321';

$short_url = Shorten\Shorten::url($long_url); // returns the short version of the long_url as a string 

测试

要运行测试，请从项目文件夹中运行以下命令。

$ ./vendor/bin/phpunit

贡献

支持新提供者

要添加对新的URL缩短提供者的支持

1. 为您URL缩短服务编写驱动程序。检查 Bitly 驱动程序 Vinelab\UrlShortener\Drivers\Bitly 类。
2. 将您驱动程序的配置添加到配置文件中。
3. 为您驱动程序编写测试。
4. 更新 README 文件
5. 有关一般详细信息，请查看贡献指南。

支持

在Github上

安全

如果您发现任何与安全相关的问题，请通过电子邮件 mahmoud@vinelab.com 而不是使用问题跟踪器。

致谢

• Mahmoud Zalt
• 所有贡献者

许可

MIT许可证（MIT）。有关更多信息，请参阅许可文件。