README.md

Description of Kvc/Spammer-Shield

What This Package Does

This package has multiple solutions to prevent spam entries on your forms.

• Google Recaptcha integration (enabled by config file),
• Form submission timeout filter , human submission/ bot submission check
• Honeypot input that normal clients can not see on your forms only bots can fill
• Random questions (Human answerable questions randomly changes based on a dictionary)

Installation

You can install the package via composer:

composer require kvnc/spammer-shield

You can publish the config file with:

php artisan vendor:publish --tag="spammer-shield-config"

You can publish the public assets files with:

php artisan asset:publish --bench="spammer-shield"

This is the contents of the published config file:

return [
    'input_name' => env('SPAMMER_SHIELD_INPUT_NAME', 'specific_values'),
    'input_class' => env('SPAMMER_SHIELD_INPUT_CLASS', 'shield-pot'), //Don't change the class unless you did not add the class in your css
    'form_submission_time' => env('SPAMMER_SHIELD_FORM_TIME', 4), // the time bots can fill up your form in seconds, don't extends this too much
    'is_enabled' => env('SPAMMER_SHIELD_IS_ENABLED', true),
    'is_google_enabled' => env('SPAMMER_SHIELD_IS_ENABLED_CAPTCHA', false),
    'is_random_question_enabled' => env('SPAMMER_SHIELD_IS_ENABLED_RANDOM_QUESTION', true),
    'is_timeout_filter_enabled' => env('SPAMMER_SHIELD_IS_TIMEOUT_FILTER_ENABLED', false),
    'google_recaptcha_site_key' => env('SPAMMER_SHIELD_GOOGLE_SITE_KEY', ''),
    'google_recaptcha_secret_key' => env('SPAMMER_SHIELD_GOOGLE_SECRET_KEY', ''),
    'is_action_taken' => false,

];

Optionally, you can publish the views using

php artisan vendor:publish --tag="spammer-shield-views"

Usage

$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

This package derived from Spatie's laravel package base

• kvnc
• spatie
• All Contributors

License

The MIT License (MIT). Please see License File for more information.