README

此库提供了一个用于通过任何 PSR-7 兼容请求（RequestInterface 对象）使用 KeyPic 网络服务进行垃圾邮件检测的包装器。

如何安装

您可以使用 Composer 安装此库。将以下内容添加到您的 composer.json 清单文件中

{
    "require": {
        "zrashwani/key-pic": "dev-master"
    }
}

然后运行 composer install。

如何使用

要使用任何实现 PSR-7 的请求使用 keypic 网络服务

require 'vendor/autoload.php';
use Zrashwani\KeyPic\KeyPic;

$keypicObj = new KeyPic($psrRequest); //initiate and configure keypic object
$keypicObj = $keypicObj->setFormID('YOUR_KEYPIC_FORM_ID') //set form ID
                       ->setDebug(true) // set debug mode
                       ->setTokenInputName("keypic_token"); //hidden input name
$token = $keypicObj->getToken();

if($psrRequest->getMethod() == "POST"){
    $data         = $psrRequest->getParsedBody();    
    $email        = $data['EMAIL_INPUT'];
    $username     = $data['NAME_INPUT'];
    $message      = $data['MESSAGE_INPUT'];
    
    //Detect if entry is Spam? from 0% to 100%
    $spam = $keypicObj->isSpam($email, $username, $message);
    if($spam === false){
       echo "Cannot determine spam percentage.";
    }elseif($spam > 60){ //if spam percentage larger than certain number
        echo "user and/or submitted data seems spammy, spam percentage = ".$spam;
    }else{
        echo "Not Spam";
    }
}

在您的表单中，放置对 renderHtml() 方法的调用以渲染像素图像或 JavaScript，并包含 keypic 隐藏令牌字段，如下所示

<form action="" method="post">
    <!-- Your form elements here -->
    <?php echo $keypicObj->renderHtml(); ?>
</form>

如何贡献

1. 分叉此存储库
2. 为每个功能或改进创建一个新的分支
3. 从每个功能分支发送拉取请求

将新功能或改进分开到单独的功能分支，并为每个分支发送拉取请求是很重要的。

所有拉取请求都必须遵循 PSR-2 标准。

系统要求

• PHP 5.4.0+

许可证

MIT 公共许可证