api-clients / pi-hole
PHP 7 异步首个 Pi-Hole API 客户端
1.0.0
2017-08-28 20:27 UTC
Requires
- php: ^7.0
- api-clients/client-services: ^1.3
- api-clients/foundation: ^1.0
- api-clients/middleware-http-exceptions: ^2.0
- api-clients/middleware-json: ^3.0
- api-clients/middleware-user-agent: ^2.0
- api-clients/rx: ^2.2
- api-clients/transport: ^3.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-15 06:55:34 UTC
README
安装
要通过 Composer 安装,请使用以下命令,它将自动检测最新版本并将其绑定到 ^
。
composer require api-clients/pi-hole
用法
客户端需要两个东西,ReactPHP 事件循环和您的 PI Hole 主机名。一旦创建客户端,您可以调用 overview
方法来获取仪表板上显示的统计数据。
use ApiClients\Client\PiHole\AsyncClient; use ApiClients\Client\PiHole\Resource\OverviewInterface; use React\EventLoop\Factory; use function ApiClients\Foundation\resource_pretty_print; require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php'; $loop = Factory::create(); $client = AsyncClient::create($loop, 'pi-hole.local'); $client->overview()->done(function (OverviewInterface $overview) { resource_pretty_print($overview); }); $loop->run();
示例
在 examples
目录中充满了此软件包的所有类型的示例。
许可证
MIT 许可证 (MIT)
版权所有 © 2017 Cees-Jan Kiewiet
特此授予任何获得本软件及其相关文档副本(以下简称“软件”)的人免费使用软件的权利,不受任何限制,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利,并允许软件提供者使用本软件,前提是必须遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、适用于特定用途和侵权保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论这些责任是因合同、侵权或其他方式产生的,无论这些责任是否与软件或软件的使用或其他交易有关。