wowe/laravel-eloquent-scopes

Some general scopes for Eloquent

Scopes for Laravel Eloquent

This package includes some useful global scopes for Laravel Eloquent., _(*1)

Installation
Traits
Usage
Release Notes
Version Compatibility
License, _(*2)

Installation

Via Composer

composer require wowe/laravel-eloquent-scopes

Traits

ActivatableTrait

When this trait is added to an Eloquent model, it will only return rows which have the active field set to true., _(*3)

If you want to use a field with a different name than active, set a constant called ACTIVE on the Eloquent model to whichever name you would like to use., _(*4)

The following methods are included with the trait: - deactivate: sets the active field to false. - activate: sets the active field to true. - withInactive: will include all entries in results regardless of the value of the active field. - onlyInactive: will include only those entries with active fields set to false., _(*5)

Usage

Add Trait to Model

Add the ActivatableTrait to an Eloquent model., _(*6)

use Wowe\Eloquent\Scopes\ActivatableTrait;

class Test extends \Eloquent
{
    use ActivatableTrait;

    const ACTIVE = 'is_active';
}

Query Model

// Get all entries that are active
Test::all();

// Get a single entry only if active
Test::find(1);

// Get all entries
Test::withInactive()->get();

// Get all inactive entries
Test::inactiveOnly()->get();

Version Compatibility

License

This package is open-sourced software licensed under the MIT license, _(*7)