Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qirolab/laravel-bannable
Laravel bannable package for blocking and banning Eloquent models.
https://github.com/qirolab/laravel-bannable
ban block eloquent forbid laravel restrict user
Last synced: 4 days ago
JSON representation
Laravel bannable package for blocking and banning Eloquent models.
- Host: GitHub
- URL: https://github.com/qirolab/laravel-bannable
- Owner: qirolab
- License: mit
- Created: 2018-07-06T17:23:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T16:43:50.000Z (8 months ago)
- Last Synced: 2024-08-11T11:32:03.640Z (3 months ago)
- Topics: ban, block, eloquent, forbid, laravel, restrict, user
- Language: PHP
- Homepage: https://qirolab.com
- Size: 75.2 KB
- Stars: 18
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Bannable
[](https://packagist.org/packages/qirolab/laravel-bannable)
[](https://github.com/qirolab/laravel-bannable/actions?query=workflow%3ATests+branch%3Amaster)
[](https://github.com/qirolab/laravel-bannable/actions?query=workflow%3A%22Check+%26+fix+styling%22)
[](https://github.com/qirolab/laravel-bannable/actions?query=workflow%3APsalm)
[](https://github.com/qirolab/laravel-bannable)
Laravel bannable package for blocking and banning Eloquent models. Using this package any model can be made bannable such as Organizations, Teams, Groups, and others.
## Installation
Download package into the project using Composer.
```bash
composer require qirolab/laravel-bannable
```
### Registering package
> Laravel 5.5 (or higher) uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
For Laravel 5.4 or earlier releases version include the service provider within `app/config/app.php`:
```php
'providers' => [
Qirolab\Laravel\Bannable\BannableServiceProvider::class,
],
```
### Prepare Migration
Now need to add nullable `banned_at` timestamp column to model. So, create a new migration file.
```bash
php artisan make:migration add_banned_at_column_to_users_table
```
Add `$table->timestamp('banned_at')->nullable();` in this new migration file as in below example.
```php
timestamp('banned_at')->nullable();
});
}
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->dropColumn('banned_at');
});
}
}
```
Now run migration.
```bash
php artisan migrate
```
### Prepare bannable model
Use `Bannable` trait in the Model as in below example.
```
use Qirolab\Laravel\Bannable\Traits\Bannable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use Bannable;
}
```
## Available methods
### Ban model entity.
```php
$user->ban();
```
### Ban model entity with reason comment
```php
$user->ban([
'comment' => 'ban comment!',
]);
```
### Ban model entity with expire time
Here `expired_at` attribute could be `\Carbon\Carbon` instance or any time string which could be parsed by \Carbon\Carbon::parse($string) method:
```php
$user->ban([
'expired_at' => '2086-03-28 00:00:00',
]);
```
or
```php
$user->ban([
'expired_at' => '+1 year',
]);
```
or
```php
$date = Carbon::now()->addWeeks(2);
$user->ban([
'expired_at' => $date,
]);
```
### Remove ban model
On `unban` all related ban models are soft deletes.
```php
$user->unban();
```
### Check if entity is banned
```php
$user->isBanned();
```
### Check if entity is not banned
```php
$user->isNotBanned();
```
### Delete expired bans manually
```php
Qirolab\Laravel\Bannable\Models\Ban::deleteExpired();
```
## Scopes
### Get all models which are not banned
```php
$users = User::withoutBanned()->get();
```
### Get banned and not banned models
```php
$users = User::withBanned()->get();
```
### Get only banned models
```php
$users = User::onlyBanned()->get();
```
### Disable scope that hides banned models entity by default
By default all banned models will be hidden. To disable query scopes all the time you can define `disableBannedAtScope` method in bannable model.
```php
/**
* Determine which BannedAtScope should be applied or not.
*
* @return bool
*/
public function disableBannedAtScope()
{
return true;
}
```
## Events
On model entity ban `\Qirolab\Laravel\Bannable\Events\ModelWasBanned` event is fired.
On model entity unban `\Qirolab\Laravel\Bannable\Events\ModelWasUnbanned` event is fired.
## Middleware
To prevent banned users to go to protected routes `Qirolab\Laravel\Bannable\Middleware\ForbidBannedUser` middleware is created.
Register it in $routeMiddleware array of app/Http/Kernel.php file:
protected $routeMiddleware = [
'isBannedUser' => \Qirolab\Laravel\Bannable\Middleware\ForbidBannedUser::class,
]