README

俄文文档 / Русская документация

Laravel 5的自定义可编辑配置。

注意

仓库地址从 gaaarfild 更改为 garf。请不要忘记修复您的 composer.json。

此包帮助您将代码中的额外配置存储在自定义存储中。

默认情况下，它使用JSON文件。

当您需要通过GUI（例如网站设置）编辑配置时非常有用。

注意！

小心！这是该包的第二个版本，已删除回退配置。

如果您仍然需要使用它，请安装 版本 1.*

安装

要安装版本2，请在您的命令行中输入以下命令

$ composer require "garf/laravel-conf:3.*"

或者添加

"garf/laravel-conf": "3.*"

到您的 composer.json 文件的 require 部分。

然后在控制台中输入

$ composer update

更新完成后，将其添加到您的 config/app.conf 文件的 providers 部分

'providers' => [
    // ...
    Garf\LaravelConf\LaravelConfServiceProvider::class,
]

如果您想使用 Conf 门面，请将其添加到同一文件的 aliases 部分

'aliases' => [
    // ...
  'Conf' => Garf\LaravelConf\ConfFacade::class,
]

发布配置文件

要能够更改文件位置，请在控制台中执行以下命令

php artisan vendor:publish --provider="Garf\LaravelConf\LaravelConfServiceProvider" --tag="config"

然后您可以编辑文件 config/laravel-conf.php 以设置您想要的任何路径。

用法

获取配置值

Conf::get('key.to.retrieve', 'default_value');

否则将返回默认值。

可以使用 '点' 表示法

保存配置值

Conf::set('key', 'value_to_save');

可以使用 '点' 表示法

也可以使用 put 方法将多个配置值作为数组存储

$config = [
    'key1' => 'value1',
    'key2.subkey' => `value2`,
];
Conf::put($config);

从配置中删除键

Conf::forget('key');

可以使用 '点' 表示法

获取整个配置

Conf::all();

以JSON格式获取整个配置

Conf::toJson();

检查配置键是否存在

Conf::has('key.to.check');

可以使用 '点' 表示法

辅助工具

还可以使用辅助工具 conf() 来提高便利性。

用法类似于内置的 config() 辅助工具。

conf()->set('key.subkey', 'myValue');

conf('key.subkey') // will return 'myValue'

conf('non.existing.key', 'myDefaultValue') // will return 'myDefaultValue'

$config = [
    'key1' => 'value1',
    'key2.subkey' => `value2`,
];

conf($config)

自定义存储驱动程序

此包在底层使用Laravel Manager类，因此如果要以其他方式存储，则很容易添加自己的自定义存储驱动程序。您需要做的只是扩展抽象类 Garf\LaravelConf\Drivers\AbstractDriver，实现抽象方法，并调用 Conf::extend。

class MyStorageDriver extends Garf\LaravelConf\Drivers\AbstractDriver {
    // ...
}
Conf::extend('mystorage', function($app) {
    return $app->make('MyStorageDriver');
});

贡献

非常欢迎贡献。

将您的拉取请求发送到 master 分支。

许可证

MIT许可证（MIT）。有关更多信息，请参阅 许可证文件。