README

此 Laravel Nova 包允许您在代码中创建自定义设置（使用 Nova 的原生字段），并为用户创建一个可以编辑设置的 UI。

需求

• php: >=8.0
• laravel/nova: ^4.26

功能

• 代码中的设置字段管理
• 编辑设置的 UI
• 访问设置的助手函数
• 规则验证支持

截图

安装

通过 Composer 在 Laravel Nova 项目中安装此包并运行迁移

# Install nova-settings
composer require outl1ne/nova-settings

# Run migrations
php artisan migrate

在 NovaServiceProvider 的 tools() 方法中注册工具

// in app/Providers/NovaServiceProvider.php

public function tools()
{
    return [
        // ...
        new \Outl1ne\NovaSettings\NovaSettings
    ];
}

用法

注册字段

通过调用 NovaSettings::addSettingsFields() 在 NovaServiceProvider 的 boot() 函数中定义字段。

// Using an array
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    Text::make('Some setting', 'some_setting'),
    Number::make('A number', 'a_number'),
]);

// OR

// Using a callable
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields(function() {
  return [
    Text::make('Some setting', 'some_setting'),
    Number::make('A number', 'a_number'),
  ];
});

注册字段面板

// Using an array
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    Panel::make('Panel Title', [
      Text::make('Some setting', 'some_setting'),
      Number::make('A number', 'a_number'),
    ]),
]);

类型转换

如果您希望在返回值之前格式化设置的值，请将类似于 Eloquent 的 $casts 属性的数组作为第二个参数传递。

\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    // ... fields
], [
  'some_boolean_value' => 'boolean',
  'some_float' => 'float',
  'some_collection' => 'collection',
  // ...
]);

子页面

将设置页面名称作为第三个参数添加，以便在自定义子页面中列出这些设置。

\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    Text::make('Some setting', 'some_setting'),
    Number::make('A number', 'a_number'),
], [], 'Subpage');

如果您保留自定义名称为空，则字段将列在“常规”下。

要翻译页面名称，请发布翻译并添加一个新键 novaSettings.$subpage 到相应的翻译文件中，其中 $subpage 是页面名称（全部小写，缩写化）。

授权

显示/隐藏所有设置

如果您想从侧边栏中隐藏整个 Settings 区域，可以像这样授权 NovaSettings 工具

public function tools(): array
{
    return [
        NovaSettings::make()->canSee(fn () => user()->isAdmin()),
    ];
}

显示/隐藏特定设置字段

如果您只想隐藏一些设置，您可以为每个字段使用 ->canSee(fn () => ...)。例如

Text::make('A text field')
  ->canSee(fn () => user()->isAdmin()),

助手函数

nova_get_settings($keys = null, $defaults = [])

调用 nova_get_settings() 以获取格式化为常规数组的所有设置。此外，您还可以传递一个 key => value 数组作为第二个参数：nova_get_settings(['some_key], ['some_key' => 'default_value'])。

nova_get_setting($key, $default = null)

要获取单个设置的值，请调用 nova_get_setting('some_setting_key')。它将返回值或 null（如果不存在具有此类键的设置）。

您还可以将默认值作为第二个参数传递 nova_get_setting('some_setting_key', 'default_value')，如果没有找到具有给定键的设置，则将返回该默认值。

nova_set_setting_value($key, $value = null)

为给定键设置设置值。

配置

可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="config"

迁移也可以使用以下命令发布和覆盖

php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="migrations"

本地化

可以使用以下命令发布翻译文件

php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="translations"

您可以将翻译添加到 resources/lang/vendor/nova-settings/，通过创建一个带有区域名称的新翻译文件（例如 et.json）并将 JSON 从现有的 en.json 中复制过来。

致谢

• Tarvo Reinpalu

许可证

Nova Settings 是开源软件，许可协议为 MIT 许可证。