PHPackages                             cata/laravel-prohibition - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. cata/laravel-prohibition

ActivePackage[Authentication & Authorization](/categories/authentication)

cata/laravel-prohibition
========================

laravel package to add prohibition system in your application

1.1.3(3y ago)6121MITPHPPHP ^8.1

Since Mar 12Pushed 3y ago2 watchersCompare

[ Source](https://github.com/Joodek/LaravelProhibition)[ Packagist](https://packagist.org/packages/cata/laravel-prohibition)[ RSS](/packages/cata-laravel-prohibition/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

Laravel Prohibition
===================

[](#laravel-prohibition)

laravel package to add prohibition system to your application

[![](https://camo.githubusercontent.com/465e72b916fa233b949a4554f67a0a5b9067ca0986217b9e02b3c883ae273f3e/68747470733a2f2f63646e2d69636f6e732d706e672e666c617469636f6e2e636f6d2f3531322f3433322f3433323539342e706e67)](https://camo.githubusercontent.com/465e72b916fa233b949a4554f67a0a5b9067ca0986217b9e02b3c883ae273f3e/68747470733a2f2f63646e2d69636f6e732d706e672e666c617469636f6e2e636f6d2f3531322f3433322f3433323539342e706e67)

[![](/github/release/babel/babel.svg)](/github/release/babel/babel.svg)

Installation
============

[](#installation)

```
composer require cata/laravel-prohibition
```

Configurations
==============

[](#configurations)

Add this middleware to your web middlewares group in `app/Http/Kernel.php`

```
Cata\Prohibition\Middleware\ProhibitionMiddleware::class;
```

make sure to add it exactly to `app/Http/Kernel::$middlewareGroup` property in web key , otherwise it won't work,

publish the configurations using

```
php artisan vendor:publish --provider="Cata\Prohibition\ServiceProvider" --tag="config"
```

migrate the table

```
php artisan migrate
```

Usage
=====

[](#usage)

this package provides two prohibition phases, you can either ban the `User` model, or using the `ip` address, both using the same syntax and the same features

### User model

[](#user-model)

to enable the model prohibition , you should use the `Bannable` trait on your User model like this :

```
use Cata\Prohibition\Bannable;

class User extends Authenticatable
{
    use Bannable;
}
```

this will give you all you need to ban the user, here is an example

```
use App\Models\User;

$user = new User(['name' => 'foo', 'email' => 'baz']);

$user->ban()
```

this way the user will be banned forever , and will recieve 403 Forbidden error if he tries to access your application, you can customize that if you want , see the [Restriction section](#restriction) section to see how,

its rare scynario to ban your registered users forever, often you want to only ban a user for a period of time, you can do that using one of the following available methods,

```
$user->banForSeconds($seconds = 1);

$user->banForMinutes($minutes = 1);

$user->banForHours($hours = 1);

$user->banForDays($days = 1);

$user->banForWeeks($weeks = 1);

$user->banForMonths($months = 1);

$user->banForYears($years = 1);
```

you can also check if the user is banned or not

```
$user->banned() // bool
```

you can also unban the users at any time using

```
$user->unban()
```

### IP address

[](#ip-address)

you can ban non registered users using the `IP` address, all you need available on the `\Illuminate\Http\Request` class, here is how :

*using the dependency injection*

```
use Illuminate\Http\Request;

/* ... */
    public function example_method(Request $request): View
    {
        $request->ban();
    }
/* ... */
```

*using the helper method*

```
request()->ban();
```

this will ban the current ip address forever, but you can customize the period like the following :

```
$request->banForSeconds($seconds = 1);

$request->banForMinutes($minutes = 1);

$request->banForHours($hours = 1);

$request->banForDays($days = 1);

$request->banForWeeks($weeks = 1);

$request->banForMonths($months = 1);

$request->banForYears($years = 1);
```

you can also check if the ip address is banned or not

```
$request->banned() // bool
```

you can also unban the ip at any time using

```
$request->unban()
```

. . .

Using Facade
------------

[](#using-facade)

### For model

[](#for-model)

you can use the `Prohibition` facade to achieve the same results, it provides the same functionality but with different syntax, the following example, shows you how to ban one or more users using the facade :

```
use Cata\Prohibition\Facades\Prohibition;

Prohibition::banModel($user, now()->addMinute() );
```

`banModel` accept two arguments, the first one might be either `User` instance, `int` or `Collection`, and the second is optional `\Illuminate\Support\Carbon` instance.

```
use Cata\Prohibition\Facades\Prohibition;
use App\Models\User;

$users = User::take(5)->get();

// you can ban collection of users
Prohibition::banModel($users, now()->addHour() );

$user = $users->first();

// you can ban user by passing his model
Prohibition::banModel($user, now()->addHour() );

// you can ban user by passing his id
Prohibition::banModel($user->id, now()->addHour() ); // user id
```

if the second argument wasn't provided or equal `null`, the user (s) will be banned forever.

you can also check if the user is banned like the following :

```
use Cata\Prohibition\Facades\Prohibition;

// check if the user banned by passing his model
Prohibition::banned(user: $user);

// check if the user banned by passing his id
Prohibition::banned(user: $user->id);
```

or you can unban a user or collection of users :

```
use Cata\Prohibition\Facades\Prohibition;
use App\Models\User;

$user = User::first();

// you can unban user by passing his model
Prohibition::unbanModel(user: $user);

// you can unban user by passing his id
Prohibition::unbanModel(user: $user->id);

$users = User::take(5)->get();

// you can unban multiple users by passing a collection
Prohibition::unbanModel(user: $users);
```

### For IP

[](#for-ip)

you can use the `Prohibition` facade to ban IP or multiple IPs like the following :

```
use Cata\Prohibition\Facades\Prohibition;

$ip = request()->ip();

Prohibition::banIP($ip, now()->addMinute() );
```

`banIP` accept two arguments, the first one is an ip `string` or `array`, and the second is optional `\Illuminate\Support\Carbon` instance.

This means that you can go a step further and ban multiple IPs at the same time :

```
use Cata\Prohibition\Facades\Prohibition;

$ips = ["123.45.6.7","123.45.6.7","123.45.6.7","123.45.6.7"];

Prohibition::banIP($ips, now()->addHour() );
```

and for both cases, if the second argument wasn't provided or equal `null`, the ip (s) will be banned forever.

you can also check if the ip is banned using the previous method like the following :

```
use Cata\Prohibition\Facades\Prohibition;

Prohibition::banned(ip: $ip);
```

you might noticed that we used the same method, since the `banned` method accept two arguments, first is `User` instance , and second is ip address, you can pass both if you want to check for both of them ,or only one like we used in the examples.

you can unban an ip or array of ips like this :

```
use Cata\Prohibition\Facades\Prohibition;
use App\Models\User;

$ip = "123.45.6.7";

Prohibition::unbanIP($ip);

// or  array

$ips = ["123.45.6.7","123.45.6.7","123.45.6.7","123.45.6.7"];

Prohibition::unbanIP($ips);
```

Testing
=======

[](#testing)

you can test the functionality using the package test, to do so, you will need to publish the tests if you haven't yet :

```
php artisan vendor:publish  --tag="prohibition-tests"
```

this will clone a `ProhibitionTest` to your tests directory, and run it using the default laravel syntax

Restriction
===========

[](#restriction)

Banned users wether using the model or ip will by default recieve `403 Forbidden` error when trying to access your application, but you can customize it using the `error` key in the `config/prohibition.php` config file, like this

```
/* ... */

"error" => [
        "code" => 403,
        "message" => "Forbidden !"
    ]

/* ... */
```

or you can disable the aborting at all, by setting the `restriction` to `false` in the `config/prohibition.php` config file,

```
/* ... */

 "restrict" => true,

/* ... */
```

and this way you should check if they're banned using the previous methods we've mentioned

Licence
=======

[](#licence)

this package is open source project under MIT licence,

Security
========

[](#security)

you can at anytime report any vulnerabilities or any security bugs to [yassinebenaide3@gmail.com](mailto://yassinebenaide3@gmail.com)

Contribution
============

[](#contribution)

all your feedback are welcome, if you noticed any improvement issues or need some new features that you think will raise our package quality, you can submit a pull request , or raise a new issue here on github or on my email [yassinebenaide3@gmail.com](mailto://yassinebenaide3@gmail.com) , I'll make sure to review all of them,

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

5

Last Release

1156d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9012457ef64e3df95f78c72e26a5a27e412873ba5fdc8dde146bc30951c47dd6?d=identicon)[yassinebenaid](/maintainers/yassinebenaid)

---

Top Contributors

[![yassinebenaid](https://avatars.githubusercontent.com/u/101285507?v=4)](https://github.com/yassinebenaid "yassinebenaid (22 commits)")

### Embed Badge

![Health badge](/badges/cata-laravel-prohibition/health.svg)

```
[![Health](https://phpackages.com/badges/cata-laravel-prohibition/health.svg)](https://phpackages.com/packages/cata-laravel-prohibition)
```

###  Alternatives

[lab404/laravel-impersonate

Laravel Impersonate is a plugin that allows to you to authenticate as your users.

2.3k16.4M48](/packages/lab404-laravel-impersonate)[santigarcor/laratrust

This package provides a flexible way to add Role-based Permissions to Laravel

2.3k5.4M43](/packages/santigarcor-laratrust)[overtrue/laravel-follow

User follow unfollow system for Laravel.

1.2k404.7k5](/packages/overtrue-laravel-follow)[codegreencreative/laravel-samlidp

Make your PHP Laravel application an Identification Provider using SAML 2.0. This package allows you to implement your own Identification Provider (idP) using the SAML 2.0 standard to be used with supporting SAML 2.0 Service Providers (SP).

263763.5k1](/packages/codegreencreative-laravel-samlidp)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)