FilamentPHP 插件骨架安装与使用指南

FilamentPHP 插件骨架安装与使用指南

plugin-skeleton A package skeleton for developing Filament plugins. 项目地址: https://gitcode.com/gh_mirrors/pl/plugin-skeleton

---

项目概述

FilamentPHP 的 plugin-skeleton 是一个基础插件模板，旨在帮助开发者快速搭建自己的FilamentPHP插件。它提供了一个标准化的结构，使得开发、配置和集成到现有项目中变得更加简便。

---

1. 项目目录结构及介绍

以下是plugin-skeleton的基本目录结构及其简要说明：

your-plugin-name/
├── src                      # 核心源代码目录
│   ├── Plugin.php           # 主插件类文件，定义插件行为和初始化
│   └── ...
├── migrations               # 数据库迁移文件存放处
├── resources                # 包含视图、语言文件等资源
│   ├── assets               # 静态资源如CSS、JavaScript文件
│   ├── lang                  # 多语言支持文件夹
│   │   └── en                # 英语语言包
│   └── views                 # 视图文件，用于前端展示
├── tests                    # 单元测试目录
├── composer.json            # Composer依赖管理文件
├── filament.php             # Filament特定配置文件
└── README.md                # 项目说明文档

• src: 存放核心业务逻辑，Plugin.php是你的插件主入口。
• migrations: 数据库迁移脚本，用于版本控制数据库结构变化。
• resources: 包括插件的所有前端资源、语言文件和视图模板。
• tests: 如果进行单元测试，这里将存放相关的测试代码。
• composer.json: 定义了项目依赖和自动加载规则。
• filament.php: 插件在Filament环境中的具体配置。

---

2. 项目的启动文件介绍

• 主要启动文件：通常，在Filament的上下文中，并不是直接有一个“启动文件”来专门负责插件启动。但是，src/Plugin.php扮演着极其关键的角色。这是你首次与Filament框架交互的地方，你需要在这里注册服务、设置路由、添加权限等。通过实现或扩展必要的接口和方法，插件会在Filament应用启动时被激活并执行其初始化逻辑。

// 假设的Plugin.php示例片段
class YourPlugin extends \Filament\Plugin
{
    public function register()
    {
        // 注册菜单项、页面或者小部件等
        $this->menus->addItems(...);
        // 其他初始化逻辑...
    }
}

---

3. 项目的配置文件介绍

• filament.php配置文件：这个文件位于根目录下，虽然是项目级别的配置文件，但它允许你对插件如何融入Filament环境做特定配置。在这个文件里，你可以指定插件的名字、图标、版本号以及任何自定义的配置选项，这些配置会被Filament读取以更好地集成你的插件。

return [
    'name' => 'Your Plugin Name',
    'slug' => 'your-plugin-slug',
    'version' => '1.0.0',
    'description' => 'A brief description of your plugin.',
    // 可能还有其他自定义配置项...
];

确保按照你的需求调整上述配置值，这有助于正确显示和管理你的插件。

---

以上内容构成了使用plugin-skeleton创建的FilamentPHP插件的基础框架介绍。正确理解和配置这些部分，你就可以开始构建功能丰富的Filament插件了。

plugin-skeleton A package skeleton for developing Filament plugins. 项目地址: https://gitcode.com/gh_mirrors/pl/plugin-skeleton