README

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

要求

• php: >=7.2
• laravel/nova: ^3.0

功能

• 代码中管理设置字段
• 编辑设置的 UI
• 访问设置的辅助函数
• 规则验证支持
• 支持 eminiarts/nova-tabs
• 支持 nova-translatable 带规则验证

屏幕截图

安装

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

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

# Run migrations
php artisan migrate

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

// in app/Providers/NovaServiceProvider.php

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

用法

注册字段

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

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

// OR

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

注册字段面板

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

类型转换

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

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

子页面

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

\OptimistDigital\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)

调用 nova_get_settings() 以获取格式化为常规数组的所有设置。如果您传递一个数组 $keys，它将仅返回列出的键。

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="OptimistDigital\NovaSettings\NovaSettingsServiceProvider" --tag="config"

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

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

本地化

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

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

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

致谢

• Tarvo Reinpalu

许可

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