README

包描述：将Laravel与Yourls（您的自定义URL缩短器）集成的插件。

安装

通过Composer安装

composer require phpsa/laravel-yourls-plugin

注册服务提供者

注意！如果您使用laravel>=5.5并启用包自动发现功能，则以下步骤是可选的。

将服务提供者添加到config/app.php中的providers部分

Phpsa\LaravelYourlsPlugin\ServiceProvider::class,

注册外观

在config/app.php中的aliases部分注册包外观

'ShortUrl' => Phpsa\LaravelYourlsPlugin\Facades\LaravelYourlsPlugin::class,

发布配置文件（可选）

php artisan vendor:publish --provider="Phpsa\LaravelYourlsPlugin\ServiceProvider" --tag="config"

配置设置

您可以在环境文件中设置以下值

LARAVEL_YOURLS_PLUGIN_URL=
LARAVEL_YOURLS_PLUGIN_USERNAME=
LARAVEL_YOURLS_PLUGIN_PASSWORD=
LARAVEL_YOURLS_PLUGIN_SIGNATURE=
LARAVEL_YOURLS_PLUGIN_FORMAT=json

身份验证可以使用用户名/密码组合或签名

用法

使用外观：您可以访问以下方法

shorturl

为您的长URL生成短URL

\ShortUrl::shorturl(string $url [, string $title = NULL [], string $keyword = NULL [], string $format = NULL ]]] )

参数

• $url - 必须的 - 您希望创建短URL的URL
• $title - 可选的 - 短URL的标题
• $keyword - 可选的 - 短URL的标题（例如 short.url/{keyword}）
• $format - 可选的 - 更改此特定请求的格式（json / xml）

返回值 string - 生成的短URL

expand

扩展关于您的短URL的信息

\ShortUrl::expand(string $shorturl [, string $format = null] )

参数

• $shorturl - 必须的 - 要扩展的短URL（可以是'abc'或'http://site/abc')
• $format - 可选的 - 更改此特定请求的格式（json / xml）

返回值 stdClass - 响应详细信息的对象

urlStats

获取一个短URL的统计信息

\ShortUrl::expand(string $shorturl [, string $format = null] )

参数

• $shorturl - 必须的 - 要扩展的短URL（可以是'abc'或'http://site/abc')
• $format - 可选的 - 更改此特定请求的格式（json / xml）

返回值 stdClass - 响应详细信息的对象

stats

获取一个短URL的统计信息

\ShortUrl::stats( [string $filter = null [, int $limit = null [, string $format = null ]]] )

参数

• $filter - 可选的 - 过滤器：可以是"top"、"bottom"、"rand"或"last"
• $limit - 可选的 - 限制（返回的最大链接数）
• $format - 可选的 - 更改此特定请求的格式（json / xml）

返回值 stdClass - 响应详细信息的对象

dbStats

获取一个短URL的统计信息

\ShortUrl::dbStats([ string $format = null] )

参数

• $format - 可选的 - 更改此特定请求的格式（json / xml）

返回值 stdClass - 响应详细信息的对象

getLastResponse

获取最后请求的完整响应体

\ShortUrl::getLastResponse()

参数 N/A

返回值 stdClass|string 最后请求体的响应

安全

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

致谢

• Craig Smith
• 所有贡献者