README

联系方式：matt.libera@uncg.edu

简介

此包是 UNCG CirQlive API PHP 库包的 Laravel 包装器，以便 CirQlive API PHP 库可以在 Laravel 应用中使用。

这是一个正在进行的工程。目前不建议用于生产应用。

安装

composer require 'uncgits/cirqlive-api-wrapper-laravel'
将Uncgits\CirqliveApiLaravel\ServiceProvider::class,添加到您的config/app.php文件中
运行php artisan vendor:publish --provider='Uncgits\CirqliveApiLaravel\ServiceProvider'以发布cirqlive-api.php配置文件
在您的.env文件中设置环境凭据，并在config/cirqlive-api.php中设置配置选项

注意：不要为CIRQLIVE_API_HOST使用协议（http:// 或 https://）

CIRQLIVE_API_HOST=

CIRQLIVE_API_USERNAME=
CIRQLIVE_API_PASSWORD=
CIRQLIVE_API_AUTH_METHOD=

依赖项

此包依赖于uncgits/cirqlive-api-php-library和barryvdh/laravel-debugbar（开发版）

用法

基本用法/入门

在您的代码中，假设您已在.env文件中正确设置了信息/凭据，您应该能够实例化Uncgits\CirqliveApiLaravel\CirqliveApi类，然后使用其任何可用方法（从Uncgits\CirqliveApi\CirqliveApi继承）来执行 API 调用。

配置选项

通知模式

此库中集成了两种通知选项。您可以将信息作为闪存消息显示在屏幕上，或将它记录在 Laravel 日志中（无论您设置为何种方式）。

在config/cirqlive-api.php文件中，notification_mode是一个数组。在内部，添加一个或两个flash和log。

如果您选择将其集成到您的应用的高级自定义通知/日志系统中，可以留空此数组以禁用这两种方法，然后根据 API 调用返回的数组（API 类返回每次调用的整个响应，包括响应代码）来处理自己的日志。

截至版本 0.7，不包括闪存消息包。您可以自由安装自己的 - 推荐使用laracasts/flash或实现类似 API 的其他东西。

调试模式

需要 Barryvdh 的 DebugBar

如果您在config/cirqlive-api.php文件中开启调试模式，调用将会有更多详细信息写入到 DebugBar 中。这包括时间、哈希缓存键以及每次调用的完整结果。

> 注意：根据此包的最佳实践，此功能仅在应用环境未设置为production时才有效

缓存

为了速度、遵守速率限制和整体性能，此库集成了缓存功能。它利用 Laravel 缓存机制（类似于日志，可以在 Laravel 配置中设置）。您可以通过在.env文件中添加CIRQLIVE_API_CACHING=off来选择性地禁用此功能。

缓存 TTL

默认情况下，缓存的有效期设置为10分钟，但您可以通过在.env文件中添加CIRQLIVE_API_CACHE_MINUTES=x来设置缓存在x分钟后过期。

缓存端点

缓存仅针对特定端点执行（例如，相当于典型 GET 请求的请求）。显然，您不会希望缓存旨在实际修改 CirQlive 中信息（相当于 POST 或 PATCH 或 DELETE 请求）的请求。

默认情况下，在 config/cirqlive-api.php 中已设置了一组基本端点。如果您想更改要缓存或不缓存的端点（或添加您自己的），只需修改配置文件中的 cached_endpoints 数组。

版本历史

0.3.1

改为 PSR-4 声明，因为我们已经遵循了它

0.3

修复了 HTTP 代理的配置键

注意：如果升级，请确保将新配置键添加到您的 cirqlive-api.php 配置文件中，并在使用代理的情况下在 .env 文件中设置它们。

0.2.1

将 env() 调用更改为 config() 调用，以便可以使用配置缓存。

0.2

删除了 standaniels/flash 作为依赖项。安装闪存包是可选的。

0.1.1

已更正 composer.json 以要求 CirQlive API 库。

0.1

第一个实际版本。
为 CirQlive 凭据提供 .env 集成
调试模式
缓存

uncgits / cirqlive-api-wrapper-laravel

维护者

详细信息