Filament Feature Flags 项目使用教程

Filament Feature Flags 项目使用教程

filament-feature-flags Filament implementation of feature flags and segmentation with Laravel Pennant. 项目地址: https://gitcode.com/gh_mirrors/fi/filament-feature-flags

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

本项目是基于 Laravel Pennant 实现的 Filament Feature Flags 功能，它允许开发者通过特性标志（feature flags）来控制用户或用户群体的功能访问。以下是项目的目录结构及各部分的简要介绍：

filament-feature-flags/
├── .gitattributes
├── .gitignore
├── .github/
│   ├── ...
├── app/
│   └── Features/
│       └── WalletFunding.php
├── config/
│   └── filament-feature-flags.php
├── database/
│   └── migrations/
│       └── ...
├── public/
│   └── ...
├── resources/
│   └── ...
├── routes/
│   └── ...
├── src/
│   └── ...
├── tests/
│   └── ...
├──vendor/
│   └── ...
└── README.md

• .gitattributes: 指定 Git 的一些行为，比如文件的换行符风格。
• .gitignore: 指定 Git 忽略的文件和目录。
• .github/: 包含 GitHub 工作流和相关文件的目录。
• app/Features/: 存放所有自定义特性类的目录。
• config/: 包含项目配置文件的目录。
• database/migrations/: 包含数据库迁移文件的目录。
• public/: 公共目录，通常包含静态文件和入口文件。
• resources/: 资源目录，包含视图、语言文件、配置文件等。
• routes/: 路由文件，定义应用的路由。
• src/: 包含本项目的主代码。
• tests/: 测试文件存放目录。
• vendor/: 通过 Composer 安装的依赖。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动主要涉及以下几个文件：

• composer.json: 定义了项目的依赖，以及其他一些元数据。
• config/app.php: 应用配置文件，定义了应用的基本配置，包括服务提供者和中间件。
• routes/web.php: 前端路由文件，定义了应用的 HTTP 路由。

安装依赖后，需要注册相关服务提供者和路由：

// config/app.php

'providers' => [
    // ...
    Stephenjude\FilamentFeatureFlag\FeatureFlagPluginServiceProvider::class,
    // ...
],

'aliases' => [
    // ...
    'FilamentFeatureFlag' => Stephenjude\FilamentFeatureFlag\FilamentFeatureFlag::class,
    // ...
],

在路由文件中注册插件：

// routes/web.php

public function panel(Panel $panel): Panel
{
    return $panel->plugins([
        Stephenjude\FilamentFeatureFlag\FeatureFlagPlugin::make(),
    ]);
}

3. 项目的配置文件介绍

配置文件位于 config/filament-feature-flags.php，以下是配置文件的主要内容：

return [
    // 特性标志的默认状态
    'default' => true,

    // 默认的作用域模型
    'scope' => App\Models\User::class,

    // 用户分段的配置
    'segments' => [
        [
            'column' => 'email',
            'source' => [
                'model' => App\Models\User::class,
                'value' => 'email',
                'key' => 'email',
            ],
        ],
    ],

    // Filament 管理面板的配置
    'panel' => [
        'group' => 'Settings',
        'label' => 'Manage Features',
        'title' => 'Manage Features & Segments',
        'icon' => 'heroicon-o-cursor-arrow-ripple',
    ],
];

在配置文件中，可以设置特性标志的默认状态，默认的作用域模型，以及定义不同的用户分段。此外，还可以配置 Filament 管理面板的相关信息，如分组、标签、标题和图标。

filament-feature-flags Filament implementation of feature flags and segmentation with Laravel Pennant. 项目地址: https://gitcode.com/gh_mirrors/fi/filament-feature-flags