README

适用于 Laravel 5.* 的 Google Url Shortener API 包。库用于缩短 URL、展开 URL 和获取缩短 URL 的统计信息。例如 goo.gl/XXXXX

安装

要在项目中安装，请在项目目录中运行以下命令

$ composer require mbarwick83/shorty

Laravel < 5.5

然后在 config/app.php 中将以下内容添加到 providers 数组中

Mbarwick83\Shorty\ShortyServiceProvider::class

同样在 config/app.php 中，将 Facade 类添加到 aliases 数组中

'Shorty'    => Mbarwick83\Shorty\Facades\Shorty::class

Laravel >= 5.5

不需要修改 config/app.php，因为提供者和别名将通过自动发现获取。

配置

要发布 Shorty 的配置文件，运行以下 vendor:publish 命令

php artisan vendor:publish --provider="Mbarwick83\Shorty\ShortyServiceProvider"

这将在您的配置目录中创建一个 shorty.php 文件。在这里，您必须输入您的 Google Shortener URL API 密钥。在 https://developers.google.com/url-shortener/v1/getting_started#APIKey 获取 API 密钥。

使用方法

请确保在您计划使用此库的任何地方包含类的命名空间

use Mbarwick83\Shorty\Facades\Shorty;

#####缩短 URL

$url = "http://google.com";

Shorty::shorten($url);

// returns, http://goo.gl/XXXXX

#####展开缩短的 URL

$url = "http://goo.gl/XXXXX";

Shorty::expand($url);

// returns, http://google.com

#####获取缩短 URL 的统计信息

$url = "http://goo.gl/XXXXX";

Shorty::stats($url);

如果成功，统计响应将返回

{
 "kind": "urlshortener#url",
 "id": "http://goo.gl/fbsS",
 "longUrl": "http://www.google.com/",
 "status": "OK",
 "created": "2009-12-13T07:22:55.000+00:00",
 "analytics": {
  "allTime": {
   "shortUrlClicks": "3227",
   "longUrlClicks": "9358",
   "referrers": [ { "count": "2160", "id": "Unknown/empty" } /* , ... */ ],
   "countries": [ { "count": "1022", "id": "US" } /* , ... */ ],
   "browsers": [ { "count": "1025", "id": "Firefox" } /* , ... */ ],
   "platforms": [ { "count": "2278", "id": "Windows" } /* , ... */ ]
  },
  "month": { /* ... */ },
  "week": { /* ... */ },
  "day": { /* ... */ },
  "twoHours": { /* ... */ }
 }
}

变更日志

请参阅 CHANGELOG 获取更多最近更改的信息。

测试

$ composer test

贡献

请参阅 CONTRIBUTING 和 CONDUCT 获取详细信息。

安全

如果您发现任何安全问题，请通过：author_email 发送电子邮件，而不是使用问题跟踪器。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。