Skip to content
Akismet for Laravel 5.8
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config php-cs-fixer to psr2 rules Jun 14, 2017
src added support for laravel58 .. Feb 27, 2019
tests updated tests to phpunit 7 ... Feb 15, 2018
.gitignore
README.md
composer.json added support for laravel58 .. Feb 27, 2019
phpunit.xml.dist updated tests to phpunit 7 ... Feb 15, 2018

README.md

Laravel Akismet

Installation

Install this package with composer:

composer require nickurt/laravel-akismet

Add the provider to config/app.php file

'nickurt\Akismet\ServiceProvider',

and the facade in the file

'Akismet' => 'nickurt\Akismet\Facade',

Copy the config files for the api

php artisan vendor:publish --provider="nickurt\Akismet\ServiceProvider" --tag="config"

Configuration

The Akismet information can be set with environment values in the .env file (or directly in the config/akismet.php file)

AKISMET_APIKEY=MY_UNIQUE_APIKEY
AKISMET_BLOGURL=https://my-custom-blogurl.dev

Examples

Validation Rule

You can use a hidden-field akismet in your Form-Request to validate if the request is valid

$validator = validator()->make(['akismet' => 'akismet'], ['akismet' => [new \nickurt\Akismet\Rules\AkismetRule(
    request()->input('email'), request()->input('name')
)]]);

The AkismetRule requires a email and name parameter to validate the request.

Events

You can listen to the IsSpam, ReportSpam and ReportHam events, e.g. if you want to log all the IsSpam-requests in your application

IsSpam Event

This event will be fired when the request contains spam nickurt\Akismet\Events\IsSpam

ReportSpam Event

This event will be fired when you succesfully reported spam nickurt\Akismet\Events\ReportSpam

ReportHam Event

This event will be fired when you succesfully reported ham nickurt\Akismet\Events\ReportHam

Custom Implementation

Validate Key
if( \Akismet::validateKey() ) {
    // valid
} else {
    // invalid
}
Set CommentAuthor Information
\Akismet::setCommentAuthor("John Doe")
    ->setCommentAuthorUrl("https://www.google.com")
    ->setCommentContent("It's me, John!")
    ->setCommentType('registration');
    // etc
    
// or
\Akismet::setCommentAuthor("John Doe");
\Akismet::setCommentAuthorUrl("https://www.google.com");
\Akismet::setCommentContent("It's me, John!");
// etc
Get CommentAuthor Information
if( \Akismet::getCommentAuthor() == 'John Doe' ) {
    // it's me John!
}
Is it Spam?
if( \Akismet::isSpam() ) {
    // yes, i'm spam!
}
Submit Spam (missed spam)
if( \Akismet::reportSpam() ) {
    // yes, thanks!
}
Submit ham (false positives)
if( \Akismet::reportHam() ) {
    // yes, thanks!
}

Tests

phpunit

You can’t perform that action at this time.