pascalvgemert/laravel-lookupable

Lookupable Trait for Laravel eloquent models for quick and efficient table lookups.

0.1.3 2019-08-19 13:56 UTC

Requires

• php: >=7.0
• illuminate/database: 5.5.x|5.6.x|5.7.x|5.8.x

MIT

• Pascal van Gemert

• lookup
• lookup tables
• pascalvgemert
• laravel-lookupable

README

Lookupable Trait for Laravel eloquent models for quick and efficient table lookups.

Requires Laravel 5.5 or higher!

About the package

When building more complex applications, lookup queries can add up without you even knowing. The lookupable trait will only get the lookup instances once per request and store them in memory. Every next time you want to lookup a lookupable instance of the same Model, the lookup methods will access the in memory stored instances and prevent a query.

Example: You have a lookup table for statuses like pending, draft, published, deleted. You can access these instances multiple times, with only one query per request:

$draftStatus = Status::lookup('draft'); // Executes the select * query and puts all instances in memory
$publishedStatus = Status::lookup('published'); // Will get the instance from memory
$deletedStatus = Status::lookup('deleted'); // Will get the instance from memory

Installation

You can install the package via composer:

composer require pascalvgemert/laravel-lookup

Usage

The Lookupable trait can be used only for Eloquent Models

class Role extends \Illuminate\Database\Eloquent\Model
{
    use Lookupable/Lookupable;
}

Example table scheme for 'Roles'

id	identifier	title
1	admin	Admin User
2	user	System User
3	guest	Guest User

Lookupable methods

After this you can lookup instances easily with the following methods:

Single Lookup

/** @var \App\Models\Role|null **/
$role = Role::lookup('admin');

Single Lookup which throws an \Illuminate\Database\Eloquent\ModelNotFoundException error when no record could be found

/** @var \App\Models\Role **/
$role = Role::lookupOrFail('admin');

Multiple Lookup

/** @var \Illuminate\Database\Eloquent\Collection **/
$roles = Role::lookupMany(['admin', 'guest']);

Multiple Lookup which throws an \Illuminate\Database\Eloquent\ModelNotFoundException error when any of the given record could NOT be found

/** @var \Illuminate\Database\Eloquent\Collection **/
$roles = Role::lookupManyOrFail(['admin', 'guest']);

Soft Deleted items

All of the above methods can except a second parameter (bool $withTrashed = false;), to also return with Soft Deleted items.

Note: When trying to use the Soft Deleted items, please make sure your Eloquent Model implements the \Illuminate\Database\Eloquent\SoftDeletes trait.

I don't have an identifier column?

So your database table doesn't contain an identifier column and looks like this Country table for example:

id	code	title
1	NL	Netherlands
2	UK	Great Brittain
3	BE	Belgium
4	US	United States
5	...	...

No worries, you can define your own lookup column name in your model like so:

class Country extends \Illuminate\Database\Eloquent\Model
{
    use Lookupable/Lookupable;
    
    protected $lookupColumn = 'code';
}

Credits

• Pascal van Gemert
• Kevin op den Kamp (for inspiration)
• Startselect