tvaliasek/simple-php-akismet

Simple class for check comment or contact form spam against Akismet API

0.1.0 2020-09-06 23:31 UTC

Requires

• php: ^7.4

Requires (Dev)

• guzzlehttp/guzzle: ^7.0
• phpunit/phpunit: ^9.3

MIT

• tvaliasek

README

Very simple modern PHP implementation of Akismet spam check service.

Install

composer require tvaliasek/simple-php-akismet

Use

use SimpleAkismet\Client;
use SimpleAkismet\DataObject\Message;
use SimpleAkismet\Exception\AkismetException;
use SimpleAkismet\Exception\InvalidKeyException;
use SimpleAkismet\Exception\InvalidStatusCodeException;

/* 
* Client covers all four API methods: 
* verifyKey, checkSpam, submitSpam and submitHam 
*/
$client = new Client(
    'yourAkismetApiKey',
    'https://www.example.com/',
    new \GuzzleHttp\Client()
);

$message = (new Message())
    ->setBlog('https://www.example.com/')
    ->setCommentAuthorEmail('[e-mail]')
    ->setCommentContent('Cheap viagra for sale on: www.foo.com')
    ->setCommentDateGmt(new \DateTime());
    // all available fields has their own setter and getter

try {
    if ($client->checkSpam($message)) {
        // do something with spam message
    }
} catch (AkismetException | InvalidKeyException | InvalidStatusCodeException $e) {
    // ...
}