Download the PHP package aw-studio/laravel-states without Composer

On this page you can find all versions of the php package aw-studio/laravel-states. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-states

Laravel States

A package to make use of the finite state pattern in eloquent Models.

The package stores all states in a database table, so all states changes and the corresponding times can be traced. Since states are mapped via a relation, no additional migrations need to be created when a new state is needed for a model.

A Recommendation

Use states wherever possible! A state can be used instead of booleans like active or timestamps like declined_at or deleted_at:

This way you also know when the change to active has taken place. Also your app becomes more scalable, you can simply add an additional state if needed.

Table Of Contents

Setup

  1. Install the package via composer:

  2. Publish the required assets:

  3. Run The Migrations

Basics

  1. Create A State:

  2. Create the transitions class:

  3. Define the allowed transitions:

  4. Setup your Model:

Usage

Receive The Current State

Determine if the current state is a given state:

Determine if the current state is any of a the given states:

Determine if the state has been the given state at any time:

Execute Transitions

Execute a state transition:

Prevent throwing an exception when the given transition is not allowed for the current state by setting fail to false:

Store additional information about the reason of a transition.

Determine wether the transition is allowed for the current state:

Lock the current state for update at the start of a transaction so the state can not be modified by simultansiously requests until the transaction is finished:

Eager Loading

Reload the current state:

Eager load the current state:

Query Methods

Filter models that have or dont have a current state:

Receive state changes:

Observer Events

Listen to state changes or transitions in your model observer:

Static Methods:


All versions of laravel-states with dependencies

PHP Build Version
Package Version
Requires illuminate/database Version ^8.0 | ^9.0
illuminate/support Version ^8.0 | ^9.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package aw-studio/laravel-states contains the following files

Loading the files please wait ....