Skip to content
State support for models
PHP
Branch: master
Clone or download
Latest commit 8edfdfb Oct 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github wip Sep 2, 2019
docs Adds missing dollar sign. Oct 6, 2019
src Proper support for non-string columns Oct 11, 2019
tests Proper support for non-string columns Oct 11, 2019
.editorconfig wip Sep 2, 2019
.gitattributes wip Sep 2, 2019
.gitignore Code review requested changes Sep 24, 2019
.scrutinizer.yml wip Sep 2, 2019
.styleci.yml wip Sep 2, 2019
.travis.yml Update travis Sep 27, 2019
CHANGELOG.md Proper support for non-string columns Oct 11, 2019
CONTRIBUTING.md wip Sep 2, 2019
LICENSE.md wip Sep 2, 2019
README.md Fix small typo in README Oct 14, 2019
composer.json Removes blank line. Oct 6, 2019
phpunit.xml.dist wip Sep 2, 2019

README.md

Adding state behaviour to Eloquent models

Latest Version on Packagist Build Status Quality Score StyleCI Total Downloads

This package adds state support to models. It combines concepts from the state pattern and state machines.

It is recommended that you're familiar with both patterns if you're going to use this package.

To give you a feel about how this package can be used, let's look at a quick example.

Imagine a model Payment, which has three possible states: Pending, Paid and Failed. This package allows you to represent each state as a separate class, handles serialization of states to the database behind the scenes, and allows for easy state transitions.

For the sake of our example, let's say that, depending on the state, a the color of a payment should differ.

Here's what the Payment model would look like:

use Spatie\ModelStates\HasStates;

/**
 * @property \App\States\PaymentState state
 */
class Payment extends Model
{
    use HasStates;

    protected function registerStates(): void
    {
        $this
            ->addState('state', PaymentState::class)
            ->allowTransition(Pending::class, Paid::class)
            ->allowTransition(Pending::class, Failed::class, PendingToFailed::class);
    }
}

This is what the abstract PaymentState class would look like:

use Spatie\ModelStates\State;

abstract class PaymentState extends State
{
    abstract public function color(): string;
}

Here's a concrete implementation of one state, the Paid state:

class Paid extends PaymentState
{
    public function color(): string
    {
        return 'green';
    }
}

And here's how it it used:

$payment = Payment::find(1);

$payment->state->transitionTo(Paid::class);

echo $payment->state->color();

Installation

You can install the package via composer:

composer require spatie/laravel-model-states

Usage

Please refer to the docs to learn how to use this package.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

License

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

You can’t perform that action at this time.