tatter/推倒

CodeIgniter 4 的 Pushover 集成

v1.0.0 2020-07-01 01:25 UTC

README

CodeIgniter 4 的 Pushover 集成

快速开始

  1. 使用 Composer 安装: > composer require tatter/pushover
  2. 将凭证添加到 .envConfig/Pushover.php
  3. 发送警报: service('pushover')->message(['message' => 'Hello world'])->send();

描述

Tatter\Pushover 为你的 CodeIgniter 4 项目添加了一个易于使用的 Pushover 类。通过集成的服务和支持实体发送推送通知并访问其他 API 端点。

配置(可选)

可以通过扩展其配置文件来改变库的默认行为。将 examples/Pushover.php 复制到 app/Config/,并遵循注释中的说明。如果在 app/Config 中找不到配置文件,则库将使用其自身的。

为了与 Pushover 交互,你需要指定你的用户密钥和应用程序令牌。由于这些是敏感项,强烈建议你通过 .env 文件而不是直接向仓库代码提供它们,例如(虚构值)

pushover.user = e9e1495ec75826de5983cd1abc8031
pushover.token = KzGDORePKggMaC0QOYAMyEEuzJnyUi

使用方法

使用 CodeIgniter 的服务助手加载服务

$pushover = service('pushover');

然后创建你的消息并发送到 Pushover

use Tatter\Pushover\Entities\Message;

$message = new Message([
	'title'    => 'My Message',
	'message'  => 'This is my first CodeIgniter push notification!',
	'priority' => 1,
]);

$pushover->sendMessage($message);

你也可以使用类便利方法来创建具有预定义默认属性的 Messages(请参阅 examples/Pushover.php 进行配置)

$message = $pushover->message(['message' => 'Hellow world']);
$message->send();

故障排除

遵循 Pushover 的 API 规范 以确保你的消息有效,并且你的使用符合他们的政策。如果出现问题,请使用类方法 Pushover::getErrors() 访问任何错误消息

try
{
	$pushover->message(['title' => 'New Boots', 'attachment' => 'boots.jpg'])->send();
}
catch (\Tatter\Pushover\Exceptions\PushoverException $e)
{
	d($pushover->getErrors());
}
...
array (2) [
    0 => string (23) "message cannot be blank"
    1 => string (37) "The API returned a failing status: 0."
]

开发

目前,此模块仅支持 messages.json 端点(包括附件),但未来将添加更多端点。如果你有特定的请求,请提出一个新功能请求的问题(或 PR)!