cedx/yii2-akismet

Akismet connector for the Yii Framework.

v7.0.0 2017-12-10 15:08 UTC

README

PHP Yii Framework Release License Downloads Coverage Build

Prevent comment spam using the Akismet connector for Yii, high-performance PHP framework.

Documentation

Development

Features

  • Key verification: checks an Akismet API key and gets a value indicating whether it is valid.
  • Comment check: checks a comment and gets a value indicating whether it is spam.
  • Submit spam: submits a comment that was not marked as spam but should have been.
  • Submit ham: submits a comment that was incorrectly marked as spam but should not have been.

Requirements

The latest PHP and Composer versions to use the Akismet library.

If you plan to play with the sources, you will also need the latest Robo and Material for MkDocs versions.

Installing via Composer

From a command prompt, run:

composer require cedx/yii2-akismet

Usage

In your application configuration file, you can use the following component:

<?php
use yii\akismet\{Blog, Client};

return [
  'components' => [
    'akismet' => [
      'class' => Client::class,
      'apiKey' => '123YourAPIKey',
      'blog' => [
        'class' => Blog::class,
        'url' => 'http://www.yourblog.com'
      ]
    ]
  ]
];

Once the yii\akismet\Client component initialized with your credentials, you can use its methods.

Key verification

<?php
use yii\akismet\{ClientException};

try {
  $client = \Yii::$app->akismet;
  $isValid = $client->verifyKey();
  echo $isValid ? 'The API key is valid' : 'The API key is invalid';
}

catch (ClientException $e) {
  echo 'An error occurred: ', $e->getMessage();
}

Comment check

<?php
use yii\akismet\{Author, Comment};

try {
  $comment = new Comment(
    new Author('127.0.0.1', 'Mozilla/5.0'),
    ['content' => 'A user comment', 'date' => time()]
  );

  $isSpam = $client->checkComment($comment);
  echo $isSpam ? 'The comment is spam' : 'The comment is ham';
}

catch (ClientException $e) {
  echo 'An error occurred: ', $e->getMessage();
}

Submit spam / ham

<?php
try {
  $client->submitSpam($comment);
  echo 'Spam submitted';

  $client->submitHam($comment);
  echo 'Ham submitted';
}

catch (ClientException $e) {
  echo 'An error occurred: ', $e->getMessage();
}

Events

The yii\akismet\Client class triggers some events during its life cycle.

The request event

Emitted every time a request is made to the remote service:

<?php
use yii\akismet\{Client};
use yii\httpclient\{RequestEvent};

$client->on(Client::EVENT_REQUEST, function(RequestEvent $event) {
  echo 'Client request: ', $event->request->url;
});

The response event

Emitted every time a response is received from the remote service:

<?php
use yii\akismet\{Client};
use yii\httpclient\{RequestEvent};

$client->on(Client::EVENT_RESPONSE, function(RequestEvent $event) {
  echo 'Server response: ', $event->response->statusCode;
});

Unit tests

In order to run the tests, you must set the AKISMET_API_KEY environment variable to the value of your Akismet API key:

export AKISMET_API_KEY="<123YourAPIKey>"

Then, you can run the test script from the command prompt:

composer test

Resources

License

Akismet for Yii is distributed under the MIT License.