tjournal/newrphus

此包已被放弃且不再维护。未建议替代包。

Newrphus —— 错别字报告引擎

维护者

详细信息

github.com/tjournal/newrphus

主页

源代码

问题

安装数: 39,059

依赖项: 0

建议者: 0

安全: 0

星标: 15

关注者: 3

分支: 1

0.3.0 2018-11-20 13:12 UTC

Requires

Suggests

  • monolog/monolog: Monolog sends your logs to files, sockets, inboxes, databases and various web services

MIT 293047b988746d03a044cda93098615b609be04a

slackmisprint

This package is not auto-updated.

Last update: 2020-01-24 15:49:06 UTC

README

让用户从您的网站向 Slack 发送错别字。

License Latest Stable Version

库包含 PHP 后端库和 JavaScript 前端文件。您应该使用它们两者来使错别字报告器工作。

How it works

当用户在页面上选择文本并按下 Ctrl+Enter 时，Newrphus 向 url 发送 POST 请求。您还可以包含 userId 参数以跟踪用户。在按键事件之后，它调用 callback 函数，您可以在其中告诉用户报告已发送。

如何使用

  1. 在 Slack 中创建新的 Incoming webhook。

  2. 使用 Composer 安装 PHP 库。

  3. 为 JS Ajax 调用创建后端处理程序。

    $newrphus = new TJ\Newrphus();
$reviewer->setSlackSettings([
    'endpoint' => 'https://hooks.slack.com/services/ABCDE/QWERTY',
    'channel' => '#misprints'
]);
$reviewer->report($_POST['misprintText'], $_POST['misprintUrl']);

    如果您想自定义 Slack 消息，请参阅 example.php。

  4. 将 js 包含到您想跟踪错别字的页面上。

    <script src="js/newrphus.js"></script>
<script>
  newrphus.init({
    url: 'example.php',
    userId: 12345,
    callback: function() {
      alert('Misprint sent');
    }
  });
</script>

  5. 告诉用户选择文本并按 Ctrl+Enter 发送报告。

通过 Composer 安装

composer.phar require tjournal/newrphus

然后包括 Composer 的自动加载器

require 'vendor/autoload.php';