jaymeh / laravel-publishable

Toggle the published state of your Eloquent models easily

Publishable

Toggle the published state of your Eloquent models easily.

Installation

You can install the package via composer:

composer require pawelmysior/laravel-publishable

Versions

For details about which version of this package to use with your Laravel version please see the table below:

Laravel Version	Package Version
<9.x	1.x
9.x	2.x
10.x	3.x
11.x	4.x

Preparation

To start you need to add a published_at nullable timestamp column to your table.

Put this in your table migration:

$table->timestamp('published_at')->nullable();

Now use the trait on the model

<?php
 
namespace App;
  
use Illuminate\Database\Eloquent\Model;
use PawelMysior\Publishable\Publishable;
 
class Post extends Model
{
    use Publishable;
}

Add Fillable Attribute

In Version 1.x, the published() function handles the update in a way where Laravel expects that the published_at field is fillable. As of Version 2.x, we not use fill functionality so the fillable attribute is no longer required.

Usage

You can now use those features:

// Get only published posts
Post::published()->get();
 
// Get only unpublished posts
Post::unpublished()->get();
 
// Check if the post is published
$post->isPublished();
 
// Check if the post is unpublished
$post->isUnpublished();
 
// Publish the post
$post->publish();
 
// Unpublish the post
$post->unpublish();

// Publish the post without firing model events
$post->publishQuietly();
 
// Unpublish the post without firing model events
$post->unpublishQuietly();

A post is considered published when the published_at is not null and in the past.

A post is considered unpublished when the published_at is null or in the future.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Contributing

Any contributions to this repository are welcomed. Please be aware that we are using conventional commits to assist in self documentation and reduce manual work involved with releases.

License

The MIT License (MIT). Please see License File for more information.

laravel-publishable's Issues

Add new documentation to reflect Laravel 9 Support

Add some improved documentation to the readme to talk about Laravel 9 support and which version to use.

Automatically make published_at field fillable from the trait

The trait provided in this module relies heavily on adding a new published_at field to migrations and any model that uses it. Therefore it would make sense in the initialise hook that laravel can use to add the published_at field to a list of fillable properties.

Laravel 10

Laravel 10 is due to be released very soon (potentially next week). This package needs to be updated in order to allow compatibility.

Change the PR changelog preset

The preset is currently setup to use one that doesn't quite fit our workflow. This will need to be updated to something like the "standard-changelog" preset.

Add in a new factory type that can be used

Create a factory macro which will allow you to seed a publishable field in some way.

Configurable Field name

This module currently assumes that you will always be using a published_at field on resources.

We should expose some configuration within this module which will allow you to change it to any field.

Checkout Code Action upgrade

Need to bump the version of checkout code action in CI from v2 to v3.

Conventional Commits

Implement conventional commits and conventional changelog functionality within this repository.

https://github.com/marcocesarato/php-conventional-changelog

Adding published_till

Have you thought about adding a published_till variant as well.

You could schedule a model to be visible only during those two dates and after consider it an "archive"?

Ensure all PR's use Conventional Commits.

Create a github action to ensure that all commits conform to conventional commits workflow.

Add Github Actions to run tests

Would be good to setup and run the tests through github actions.

Support for Laravel 9

Hi,

I'm interesting in this package to provide functionality for making some models publishable. Just wondering if there are any plans to add Laravel 9 support in a new version? Laravel 9 requires PHP > 8.0 so may hinder any backwards compatability.

Happy to submit a PR with dependency bumps to make this happen but I wanted to check the project scope before putting the work in.

Cheers!

Review whether using mass assignment is a good idea

I've been thinking about a recent change to include published_at as a fillable field but I'm wondering if the best solution for security would be to only update that attribute and recall save functions.

Some things to ponder:

• Overall security
• Model events (do they fire?)
• How do other packages handle this type of functionality?

Create github action for releasing a conventional changelog

I've added a PHP Library for creating a conventional changelog, I now just need to add a new action to create it.

Move away from Orchestral Database

It seems that the Orchestral Database package is no longer maintained, I've had some experience with Orchestral Testbench in the past but not sure what the difference is.

Ideally I would like to find an alternative to this and upgrade the test suite to utilise it.

Add in a new helper function for migrations

When running a migration, rather than specifically adding a field, it might be nice to have a publishable() migration helper function that allows content to apply the field much more easily. This may also make it much better when introducing new potential fields in later migrations if required.

Allow publishing to no longer fire model events

I've got a project which relies on Events and triggering publish functionality seems to cause an issue with duplicate events firing. For that some new publishQuietly and unpublishQuietly functions would be pretty useful.