library akismet

openclassrooms/akismet

Akismet Library

Akismet

, _(*1)

This is a PHP5 library that provides Akismet Spam Protection service functionality in your application., _(*2)

Installation

The easiest way to install Akismet Library is via composer., _(*3)

Create the following composer.json file and run the php composer.phar install command to install it., _(*4)

{
    "require": {
        "openclassrooms/akismet": "*"
    }
}

```php <?php require 'vendor/autoload.php';, <sub>(*5)</sub>

use OpenClassrooms\Akismet\Services\AkismetService;, <sub>(*6)</sub>

//do things, <sub>(*7)</sub>

## Basic Usage
The `AkismetServiceImpl` class needs to set a client to communicate with Akismet Spam Protection service. This library provides a client based on GuzzleHttp\Client, though you can implement your own client. Then, you can set the client using the ```AkismetServiceImpl::setClient()``` method.

### The Models
#### Comment
This Library defines a "Comment" interface which must be passed as an argument into the different AkismetService methods.
```php
use OpenClassrooms\Akismet\Models\Comment;

$comment = new CommentImpl();

Comment Builder

This library provides a Builder to create the Comment:, <sub>(*8)</sub>

use OpenClassrooms\Akismet\Models\CommentBuilder;

$comment = $commentBuilder->create()
                          ->withUserIp(CommentStub::USER_IP)
                          ->withUserAgent(CommentStub::USER_AGENT)
                          ->withReferrer(CommentStub::REFERRER)
                          ->withPermalink(CommentStub::PERMALINK)
                          ->withAuthorName(CommentStub::AUTHOR_NAME)
                          ->withAuthorEmail(CommentStub::AUTHOR_EMAIL)
                          ->withContent(CommentStub::CONTENT)
                          ->build();

Service

Use OpenClassrooms\Akismet\Services\Impl\AkismetServiceImpl;

$akismetService = new AkismetServiceImpl();

// commentCheck method needs only one parameter, which has to be the Comment object
if ($akismetService->commentCheck($comment)) {
 // store the comment and mark it as spam (in case of a misdiagnosis).
} else {
 // store the comment normally
}

to submit misdiagnosed spam and ham, which improves the system for everybody., <sub>(*9)</sub>

$akismetService->submitSpam($comment);

And, <sub>(*10)</sub>

$akismetService->submitHam($comment);

Beyond this Library

If you plan to use Akismet Library in a Symfony2 project, check out the AkismetBundle. The bundle provides an easy configuration option for this library., <sub>(*11)</sub>