cybercog / laravel-nova-ban
A Laravel Nova banning functionality for your application.
Fund package maintenance!
paypal.me/antonkomarev
Installs: 178 761
Dependents: 0
Suggesters: 0
Security: 0
Stars: 39
Watchers: 4
Forks: 6
Open Issues: 2
Requires
- php: ^7.1.3|^8.0
- cybercog/laravel-ban: ^3.0|^4.0
- laravel/nova: *
README
Introduction
Behind the scenes cybercog/laravel-ban is used.
Contents
Installation
Pull in the package through Composer.
composer require cybercog/laravel-nova-ban
Usage
Prepare bannable model
use Cog\Contracts\Ban\Bannable as BannableContract; use Cog\Laravel\Ban\Traits\Bannable; use Illuminate\Foundation\Auth\User as Authenticatable; class User extends Authenticatable implements BannableContract { use Bannable; }
Prepare bannable model database table
Bannable model must have nullable timestamp
column named banned_at
. This value used as flag and simplify checks if user was banned. If you are trying to make default Laravel User model to be bannable you can use example below.
Create a new migration file
php artisan make:migration add_banned_at_column_to_users_table
Then insert the following code into migration file:
<?php use Illuminate\Database\Migrations\Migration; use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; class AddBannedAtColumnToUsersTable extends Migration { public function up(): void { Schema::table('users', function (Blueprint $table) { $table->timestamp('banned_at')->nullable(); }); } public function down(): void { Schema::table('users', function (Blueprint $table) { $table->dropColumn('banned_at'); }); } }
Apply new migration.
Register Ban Actions in Nova Resource
Register Ban
and Unban
actions inside your Bannable
Model's Resource.
public function actions(Request $request) { return [ new \Cog\Laravel\Nova\Ban\Actions\Ban(), new \Cog\Laravel\Nova\Ban\Actions\Unban(), ]; }
Contributing
Please see CONTRIBUTING for details.
Testing
Run the tests with:
vendor/bin/phpunit
Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
Contributors
Laravel Nova Ban contributors list
Alternatives
Feel free to add more alternatives as Pull Request.
License
Laravel Nova Ban
package is open-sourced software licensed under the MIT License by Anton Komarev.Fat Boss In Jail
image licensed under Creative Commons 3.0 by Gan Khoon Lay.
About CyberCog
CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.