Laravel Packages

A Simple Draft and Revision System for Laravel

Published
A Simple Draft and Revision System for Laravel image

Laravel Drafts is a simple drop-in draft and revision system for Eloquent models. This package also supports drafts for related models; you can control saving models in a published or draft mode.

To get started with this package, your project will use the provided HasDrafts trait:

use Illuminate\Database\Eloquent\Model;
use Oddvalue\LaravelDrafts\Concerns\HasDrafts;
 
class Post extends Model
{
use HasDrafts;
// ...
}

With the trait configured, you can use the following API to control creating a published model or a draft:

// By default, the record is published
Post::create([
'title' => 'Foo',
// ...
]);
 
// You can set the record as a draft in a few different ways:
 
// Via the `is_published` flag
Post::create([
'title' => 'Foo',
'is_published' => false,
]);
 
// Calling `createDraft`
Post::createDraft(['title' => 'Foo']);
 
// Using the `saveAsDraft` method on a model
Post::make(['title' => 'Foo'])->saveAsDraft();

Similarly, you can update a model, keeping it as a draft:

$post->updateAsDraft(['title' => 'Bar']);
 
// Or
 
$post->title = 'Bar';
$post->saveAsDraft();

You can also access draft revisions and configure how many total revisions to keep in the database. The readme is an excellent place to get started with this package.

Check out this package and contribute on GitHub at oddvalue/laravel-drafts.

Paul Redmond photo

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

Sponsored

laravelcloud logo
Laravel Cloud

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

Visit Laravel Cloud

The latest

View all →
What's New in PHP 8.6 image

What's New in PHP 8.6

Read article
Building EasyReply: How We Used Laravel to Unify Customer Support image

Building EasyReply: How We Used Laravel to Unify Customer Support

Read article
PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum image

PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum

Read article
PayZephyr: One Payment API for Stripe, Paystack, and PayPal image

PayZephyr: One Payment API for Stripe, Paystack, and PayPal

Read article
Bifrost Turns One With AI Builds and New Workflows image

Bifrost Turns One With AI Builds and New Workflows

Read article
Preview Blade Templates in macOS Finder with Quick Blade image

Preview Blade Templates in macOS Finder with Quick Blade

Read article