Download the PHP package jobmetric/laravel-state-machine without Composer

On this page you can find all versions of the php package jobmetric/laravel-state-machine. 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?

Example code of jobmetric/laravel-state-machine

Informations about the package laravel-state-machine

State Machine for Eloquent laravel

This package is for implementing the Eloquent State Machine of various Laravel projects.

Install via composer

Run the following command to pull in the latest version:

Documentation

When it comes to changing the state of a model field, and we want to change it and then do other things or more clearly react to another action, you can use this package.

Usage

1. Suppose you have an order model with a status field.

2. Now you need to add a trait called HasStateMachine to the model.

3. When this attribute is added to the model, you will have to add the StateMachineContract interface to the model

4. Now you will again have to use the stateMachineAllowTransition function in the model.

Note: The stateMachineAllowTransition function is used to define the transition of the model field. In the above example, the status field can be changed from pending to processing and from processing to completed.

Why did we do these things?

By doing this, you are defining the states in which status wants to move.

Starting now, manual state manipulation is no longer permitted. Instead, you must navigate between state components using the functions provided by StateMachine. It will handle the update process and a sequence of additional tasks, which will be elaborated upon shortly.

Note: The above code will not work. Because the status field can only be changed from pending to processing and from processing to completed.

If you want to change the status field from pending to processing, you must use the following code.

Note: If it was a field other than status, you can use the second parameter for the name of that field.

Let's go to the amazing part of our story

When a transitionTo occurs, you can have an action for that event that will be executed automatically if there is one.

Let's go to the actions

To define a StateMachine, the following method must be executed:

model: The name of the model you want to create a StateMachine for.

  • The model must be available in the system

state: The name of the state you want to create a StateMachine for.

  • This part should be written like this, for example PendingToProcessing and the word To must be between two situations.

  • If this field is not filled, a status called Common will be created, which will be explained below.

field: The name of the field you want to create a StateMachine for.

  • This is the default option on the status field, and if you want to define another field, use this

When you run this command, a file is created inside app/StateMachines

In the created file, you have two methods, before and after, which tells you that you want to do it before changing the field in the database or after changing the field in the database.

In each of them, you can use different tasks such as sending e-mail or many other things.

The difference between Common and detailed files

The difference between the two Common files and PendingToProcessing mode, for example, is in their execution

The common file is executed for all conditions, but the exact state file is executed only for that specific mode, and the form of their execution is as follows

License

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

All versions of laravel-state-machine with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0.1
ext-json Version *
laravel/framework Version >=9.19
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 jobmetric/laravel-state-machine contains the following files

Loading the files please wait ....