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

masteringlaravel logo
Laravel Code Review

Get expert guidance in a few days with a Laravel code review

Visit Laravel Code Review

The latest

View all →
Volker Dusch on the PHP RCE Vulnerabilities and Disclosure image

Volker Dusch on the PHP RCE Vulnerabilities and Disclosure

Read article
Decide with Jev: Turn AI Answers into Decisions with PHP Rules image

Decide with Jev: Turn AI Answers into Decisions with PHP Rules

Read article
Skuul: Open-Source School Management Built on Laravel image

Skuul: Open-Source School Management Built on Laravel

Read article
Laravel Read Replicas: Prevent Stale Reads After a Write image

Laravel Read Replicas: Prevent Stale Reads After a Write

Read article
Screenshot: Capture Images and PDFs with PHP and Laravel image

Screenshot: Capture Images and PDFs with PHP and Laravel

Read article
Reset Sticky Database Connections Between Laravel Queue Jobs image

Reset Sticky Database Connections Between Laravel Queue Jobs

Read article