zaratedev/laravel-excludable

Exclude the provided elements from the query results.

v1.0.1 2023-01-16 23:00 UTC

This package is auto-updated.

Last update: 2024-11-18 19:32:42 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

Banner

This package allow to your eloquent models apply exclude provides elements from the query results.

Installation

You can install the package via composer:

composer require zaratedev/laravel-excludable

Usage

Use the Excludable trait in any Eloquent Model.

use Illuminate\Database\Eloquent\Model;
use ZarateDev\LaravelExcludable\Excludable;

class User extends Model
{
    use Excludable;
}

Now you have available scope exclude() method in Eloquent Model.

use App\Models\User;

class UserController extends Controller
{
    public function index()
    {
        $user = auth()->user();

        $users = User::query()->exclude($user)->get();

        return view('users.index', compact('users'));
    }
}

The method exclude can recieved attribute of type collection, model, integer, array. For more examples see test suits.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email zaratedev@gmail.com instead of using the issue tracker.

Credits

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.