Laravel Eloquent 状态机项目教程

Laravel Eloquent 状态机项目教程

laravel-eloquent-state-machinesState Machines for your Laravel Eloquent models项目地址:https://gitcode.com/gh_mirrors/la/laravel-eloquent-state-machines

1. 项目的目录结构及介绍

目录结构

laravel-elloquent-state-machines/
├── src/
│   ├── StateMachines/
│   │   ├── BaseStateMachine.php
│   │   ├── HasStateMachines.php
│   │   ├── State.php
│   │   ├── StateHistory.php
│   │   ├── StateMachine.php
│   │   ├── StateMachineServiceProvider.php
│   │   ├── Transitions/
│   │   │   ├── Transition.php
│   │   │   ├── TransitionNotAllowed.php
│   │   │   ├── TransitionNotValid.php
│   │   ├── Traits/
│   │   │   ├── StateMachineHelpers.php
│   │   │   ├── StateMachineHistoryHelpers.php
│   │   │   ├── StateMachineScopes.php
│   │   ├── Validators/
│   │   │   ├── Validator.php
│   │   │   ├── ValidatorNotImplemented.php
│   ├── config/
│   │   ├── state-machine.php
│   ├── database/
│   │   ├── migrations/
│   │   │   ├── 2020_01_01_000000_create_state_histories_table.php
│   │   ├── seeds/
│   │   │   ├── StateHistoriesTableSeeder.php
│   ├── resources/
│   │   ├── lang/
│   │   │   ├── en/
│   │   │   │   ├── state-machine.php
│   ├── tests/
│   │   ├── Feature/
│   │   │   ├── StateMachineTest.php
│   │   ├── Unit/
│   │   │   ├── StateMachineTest.php
├── composer.json
├── README.md

目录介绍

• src/：包含项目的核心代码。
  • StateMachines/：状态机的主要实现文件。
    • BaseStateMachine.php：基础状态机类。
    • HasStateMachines.php：模型与状态机关联的 trait。
    • State.php：状态类。
    • StateHistory.php：状态历史记录类。
    • StateMachine.php：状态机类。
    • StateMachineServiceProvider.php：服务提供者。
    • Transitions/：状态转换相关类。
    • Traits/：辅助 trait。
    • Validators/：验证器相关类。
  • config/：配置文件目录。
    • state-machine.php：状态机配置文件。
  • database/：数据库相关文件。
    • migrations/：数据库迁移文件。
    • seeds/：数据库种子文件。
  • resources/：资源文件目录。
    • lang/：语言文件目录。
  • tests/：测试文件目录。
• composer.json：Composer 配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

启动文件

• StateMachineServiceProvider.php：
  • 该文件是 Laravel 服务提供者，用于注册和启动状态机服务。
  • 主要功能包括：
    • 注册配置文件。
    • 注册数据库迁移。
    • 注册状态机相关的命令和服务。

使用方法

在 config/app.php 中注册服务提供者：

'providers' => [
    // 其他服务提供者
    Asantibanez\LaravelEloquentStateMachines\StateMachineServiceProvider::class,
],

3. 项目的配置文件介绍

配置文件

• config/state-machine.php：
  • 该文件包含了状态机的配置选项。
  • 主要配置项包括：
    • state_histories_table：状态历史记录表的名称。
    • state_machine_attribute：状态机属性的名称。

配置示例

return [
    'state_histories_table' => 'state_histories',
    'state_machine_attribute' => 'state_machine',
];

laravel-eloquent-state-machinesState Machines for your Laravel Eloquent models项目地址:https://gitcode.com/gh_mirrors/la/laravel-eloquent-state-machines