romano83/akismet

PSR-7 库,用于与 Akismet 服务通信,以确定提交给您的网站的评论是否应被视为垃圾邮件。

1.0 2017-12-07 11:24 UTC

This package is auto-updated.

Last update: 2024-09-17 14:16:56 UTC


README

Build Status Latest Stable Version License

一个 PHP-7 类,用于与 Akismet 服务通信,以确定提交给您的网站的评论是否应被视为垃圾邮件。

安装

需求

  • PHP 7.1

安装步骤

运行: composer require romano83/akismet 或在您的 composer.json 文件中

"require": {
    "romano83/akismet" : "^1.0"
}

如何使用它

在开始使用之前,您需要一个 Akismet API 密钥。一旦您有了它,为了检查评论是否为垃圾邮件

<?php
use Romano83\Akismet;

$website = 'https://your-website.com'; // must be a full URI including http:// or https://
$apikey = 'YOUR_API_KEY';
$akismet = new Akismet($website, $apikey);

$akismet->setCommentAuthor($author)
    ->setCommentAuthorEmail($email)
    ->setCommentContent($comment);
    
if ($akismet->isCommentSpam()) {
    // store the comment and mark it as a spam
} else {
    // store the comment normally
}

就这么简单!

如果 Akismet 过错地标记了消息,您可以使用以下方法

$akismet->submitSpam();

$akismet->submitHam();

提交误诊的垃圾邮件和正常邮件,这有助于提高每个人的系统。

其他方法

此类提供了一组方法,用于为评论检查或提交的垃圾邮件和正常邮件添加参数。这些方法包括

  • setUserIp (必需)
  • setUserAgent (必需)
  • setReferrer (注意拼写)
  • setPermalink
  • setCommentType
  • setCommentAuthor
  • setCommentAuthorEmail
  • setCommentAuthorUrl
  • setCommentContent
  • setCommentDateGmt
  • setCommentPostModifiedGmt
  • setBlogLang
  • setBlogCharset
  • setUserRole
  • setIsTest

所有方法都返回 self,以便具有流畅的接口。

如果您想了解每个方法的更多详细信息,请参阅内部文档或点击此 链接

如何贡献

  • 如果您发现了一个错误,请在 Github 上创建一个票据。
  • 如果您想提交 PR,请创建一个新的分支。
  • 您必须添加测试用例