Laravel Eloquent Status Package

Published on by

Laravel Eloquent Status Package image

The Laravel Eloquent Status package by Rasmus Christoffer Nielsen is a package that helps you check the state and status of eloquent models without cluttering them.

I am sure many of us have built something similar to the following example: let’s say you have a post model with various statuses, such as draft, scheduled, and published. With Laravel you can easily build scopes to query these states with local query scopes:

/**
* Scope a query to only include popular users.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopePublished($query)
{
return $query
->where('status', 'published')
->whereNotNull('published_at');
}

You might have deeply held opinions about how to accomplish this scope, but I think you get the idea. We can use a scope to get only published posts:

Post::published()->get();

You might have an additional conditional method for asserting the individual state of a post record:

/**
* @return bool
*/
public function isPublished()
{
return $this->status === 'published' &&
$this->published_at !== null;
}

Enter the Eloquent status package, it might be an approach you want to use on your model statuses.

Eloquent Status Package

With the Eloquent Status package now you can use an API like this to check that status of your model:

Post::status('published')->get();

On an individual model you can check the state of your object with a checkStatus method:

$post->checkStatus('scheduled'); // true or false

For this to work, you would create a dedicated status class such as PostStatus:

use \Makeable\EloquentStatus\Status;
 
class PostStatus extends Status
{
public function published($query)
{
return $query->where('status', 'published')
->whereNotNull('published_at');
}
 
public function scheduled($query)
{
return $query->where('status', 'scheduled')
->whereNotNull('scheduled_at');
}
 
// Etc...
}

Next, you define a trait on your model to support status checks:

use \Makeable\EloquentStatus\HasStatus;
 
class Post extends Eloquent
{
use HasStatus;
}

With the trait in place, you can query the database using your PostStatus class:

Post::status(new PostStatus('published'))->get();

This technique is very close to our scoped method, but the author of the package suggests a few benefits of this approach:

  • We’ve defined and encapsulated all our statuses in one place de-cluttering our model
  • We can only query against valid statuses

Trying to query on an invalid status will throw an exception:

Post::status(new PostStatus('bupkis'))->get();

Next, you can use the same status definitions to check it a model instance has a given status, which is powered by another package by Rasmus called laravel-query-kit:

$post->checkStatus(new PostStatus('published')); // Bool

My favorite feature in this package is the ability to guess the model’s status:

<?php
 
use Makeable\EloquentStatus\HasStatus;
 
class Post extends Eloquent
{
use HasStatus;
 
public function getStatusAttribute()
{
return PostStatus::guess($this);
}
}
 
// Example usage
$post->status

Learn More

Check out the package’s GitHub repo for complete installation and usage instructions. Rasmus also wrote about his package in his post An eloquent way of handling model state.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Introducing Built with Laravel image

Introducing Built with Laravel

Read article
Visual EXPLAIN for MySQL and Laravel image

Visual EXPLAIN for MySQL and Laravel

Read article
VS Code Snippets for Livewire and Alpine.js image

VS Code Snippets for Livewire and Alpine.js

Read article
A guide to Laravel's model events image

A guide to Laravel's model events

Read article
API Versioning in Laravel 11 image

API Versioning in Laravel 11

Read article
A Resize Plugin for Alpine.js image

A Resize Plugin for Alpine.js

Read article