ryangjchandler/laravel-json-settings

将Laravel应用程序设置存储在磁盘上的JSON文件中。

v0.1.0 2022-02-14 20:53 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

此包提供了一个简单的 SettingsRepository 类,可用于将应用程序设置存储在单个JSON文件中。

安装

您可以通过composer安装此包

composer require ryangjchandler/laravel-json-settings

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

php artisan vendor:publish --tag="json-settings-config"

用法

您可以通过在任何DI支持的函数中(例如控制器函数)使用类型提示来从容器中解析RyanChandler\LaravelJsonSettings\SettingsRepository的一个实例。

class IndexController
{
    public function __invoke(SettingsRepository $settings)
    {
        return view('index', [
            'title' => $settings->get('index.title'),
        ]);
    }
}

SettingsRepository类包含以下方法:

  • get(string $key, mixed $default = null) - 通过提供键(支持点表示法)检索设置的值。
  • set(string $key, mixed $value, bool $save = true) - 设置设置的值并切换自动保存。
  • has(string $key) - 判断设置是否存在。
  • save() - 手动将设置保存回磁盘。
  • reload() - 清除缓存并从磁盘重新加载设置。

如果您更喜欢使用外观,您也可以直接与RyanChandler\LaravelJsonSettings\Facades\Settings外观交互。

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全漏洞

请查看我们的安全策略了解如何报告安全漏洞。

致谢

许可协议

MIT许可(MIT)。有关更多信息,请参阅许可文件