Laravel Akismet
Installation
Install this package with composer:
composer require nickurt/laravel-akismet
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
// FormRequest ...
public function rules()
{
return [
'akismet' => [new \nickurt\Akismet\Rules\AkismetRule(
request()->input('email'), request()->input('name')
)]
];
}
// Manually ...
$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::fill([
'comment_author' => 'John Doe',
'comment_author_url' => 'https://www.google.com',
'comment_content' => 'It's me, John!'
]);
// etc
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
composer test
31 Dec 18, 2022
46 Oct 1, 2022
9 Dec 14, 2022
13 May 16, 2022
43 Dec 21, 2022
9 Nov 10, 2022
19 Jul 5, 2021
49 Jun 22, 2022
686 Dec 28, 2022
3.5k Jan 8, 2023
68 Dec 12, 2022
52 Jul 17, 2022
658 Jan 6, 2023
1 Oct 14, 2021
307 Sep 23, 2022
1 Jan 11, 2022
340 Jan 6, 2023
61 Mar 1, 2022
110 Dec 25, 2022