系统配置

Testing Is Documentation

tests/Option/OptionTest.php系统配置 - 图1

QueryPHP 为系统提供了灵活的配置，通常来说通过服务提供者将配置打包到服务容器中，可以很方便地使用。

使用方式

使用容器 option 服务

  1. \App::make('option')->set($name, $value = null): void;
  2. \App::make('option')->get(string $name = 'app\\', $defaults = null);

依赖注入

  1. class Demo
  2. {
  3.     private \Leevel\Option\IOption $option;
  5.     public function __construct(\Leevel\Option\IOption $option)
  6.     {
  7.         $this->option = $option;
  8.     }
  9. }

使用静态代理

  1. \Leevel\Option\Proxy\Option::set($name, $value = null): void;
  2. \Leevel\Option\Proxy\Option::get(string $name = 'app\\', $defaults = null);

配置目录

系统配置文件为 option 目录，每个配置文件对应不同的组件，当然你也可以增加自定义的配置文件。

  • 配置位于 option，可以定义配置文件。
  • 主要配置文件包含应用、数据库、缓存、日志、Session 等等。
  • 扩展配置 common/ui/option/test.php 目录，在 composer.json 中定义。

composer.json 可以扩展目录

  1. {
  2.     "extra": {
  3.         "leevel": {
  4.             "@options": "The extend options",
  5.             "options": {
  6.                 "test": "common/ui/option/test.php"
  7.             }
  8.         }
  9.     }
  10. }

WARNING

注意，其它软件包也可以采用这种方式自动注入扩展默认配置。

系统默认常见配置：

配置项配置描述
app应用配置
auth登陆验证
cache缓存配置
console控制台配置
cookieCookie 配置
database数据库配置
debug调试配置
filesystem文件系统配置
i18n国际化配置
log日志配置
mail邮件配置
protocolSwoole 配置
sessionSession 配置
throttler限流配置
view视图配置

配置缓存

配置支持生成缓存，通过内置的命令即可实现。

  1. php leevel option:cache

返回结果

  1. Start to cache option.
  2. Option cache file /data/codes/queryphp/bootstrap/option.php cache successed.

清理配置缓存

  1. php leevel option:clear

返回结果

  1. Start to clear cache option.
  2. Option cache file /data/codes/queryphp/bootstrap/option.php cache clear successed.

配置定义

可以直接在相应的配置文件已数组的方式定义，新的配置文件直接放入目录即可。

TIP

配置参数名严格区分大小写，建议是使用小写定义配置参数的规范。

app 应用配置中几个核心的配置项，这是整个系统关键的配置。

配置项配置值描述
environmentdevelopment运行环境，可以为 production : 生产环境 testing : 测试环境 development : 开发环境
debugtrue是否打开调试模式，可以为 true : 开启调试 false 关闭调试，打开调试模式可以显示更多精确的错误信息。
auth_key7becb888f518b20224a988906df51e05安全 key，请妥善保管此安全 key,防止密码被人破解。

环境变量定义

可以在应用的根目录下定义一个特殊的 .env 环境变量文件，一般用于平时开发使用。

自定义环境变量

可以通过 RUNTIME_ENVIRONMENT 来定义自定义的环境变量文件，比如定义 .test 的环境变量。

  1. putenv('RUNTIME_ENVIRONMENT=test');

环境变量配置格式

  1. # Environment production、testing and development
  2. ENVIRONMENT = development
  4. # Debug
  5. DEBUG = true
  6. DEBUG_JSON = true
  7. DEBUG_CONSOLE = true
  8. DEBUG_JAVASCRIPT = true
  10. ...

获取环境配置

  1. \env('environment');
  2. \Leevel::env('environment');
  3. \App::env('environment');

Uses

  1. <?php
  3. use Leevel\Option\Option;

all 返回所有配置

  1. public function testAll(): void
  2. {
  3.     $data = [
  4.         'hello'       => 'world',
  5.         'test\\child' => ['foo' => 'bar'],
  6.     ];
  8.     $option = new Option($data);
  10.     $this->assertSame($option->all(), $data);
  11. }

get 获取配置

  1. public function testGet(): void
  2. {
  3.     $data = [
  4.         'app' => [
  5.             'environment' => 'testing',
  6.             'debug'       => true,
  7.         ],
  8.         'cache' => [
  9.             'expire'      => 86400,
  10.             'time_preset' => [
  11.                 'foo' => 'bar',
  12.             ],
  13.         ],
  14.         'hello' => 'world',
  15.     ];
  17.     $option = new Option($data);
  19.     $this->assertSame('testing', $option->get('app\\environment'));
  20.     $this->assertSame('testing', $option->get('environment'), 'Default namespace is app, so it equal app\\testing.');
  21.     $this->assertNull($option->get('hello'), 'The default namespace is app, so it equal app\\hello');
  22.     $this->assertNull($option->get('app\\hello'), 'The default namespace is app, so it equal app\\hello');
  23.     $this->assertSame($option->get('hello\\'), 'world');
  24.     $this->assertSame($option->get('hello\\*'), 'world');
  26.     $this->assertSame([
  27.         'environment' => 'testing',
  28.         'debug'       => true,
  29.     ], $option->get('app\\'));
  31.     $this->assertSame([
  32.         'environment' => 'testing',
  33.         'debug'       => true,
  34.     ], $option->get('app\\*'));
  36.     $this->assertFalse([
  37.         'environment' => 'testing',
  38.         'debug'       => true,
  39.     ] === $option->get('app'), 'The default namespace is app, so it equal app\\app');
  41.     // namespace\sub.sub1.sub2
  42.     $this->assertSame($option->get('cache\\time_preset.foo'), 'bar');
  43.     $this->assertNull($option->get('cache\\time_preset.foo2'));
  44. }

has 是否存在配置

  1. public function testHas(): void
  2. {
  3.     $data = [
  4.         'app' => [
  5.             'environment' => 'testing',
  6.             'debug'       => true,
  7.         ],
  8.         'cache' => [
  9.             'expire'      => 86400,
  10.             'time_preset' => [
  11.                 'foo' => 'bar',
  12.             ],
  13.         ],
  14.         'hello' => 'world',
  15.     ];
  17.     $option = new Option($data);
  19.     $this->assertTrue($option->has('app\\environment'));
  20.     $this->assertTrue($option->has('environment'), 'Default namespace is app, so it equal app\\testing.');
  21.     $this->assertFalse($option->has('hello'), 'The default namespace is app, so it equal app\\hello');
  22.     $this->assertFalse($option->has('app\\hello'), 'The default namespace is app, so it equal app\\hello');
  23.     $this->assertTrue($option->has('hello\\'));
  24.     $this->assertTrue($option->has('hello\\*'));
  25.     $this->assertTrue($option->has('app\\'));
  26.     $this->assertTrue($option->has('app\\*'));
  27.     $this->assertFalse($option->has('app'), 'The default namespace is app, so it equal app\\app');
  29.     // namespace\sub.sub1.sub2
  30.     $this->assertTrue($option->has('cache\\time_preset.foo'));
  31.     $this->assertFalse($option->has('cache\\time_preset.foo2'));
  32. }

set 设置配置

  1. public function testSet(): void
  2. {
  3.     $data = [];
  5.     $option = new Option($data);
  7.     // set app\environment value
  8.     $option->set('environment', 'testing');
  9.     $this->assertSame('testing', $option->get('app\\environment'));
  10.     $this->assertSame('testing', $option->get('environment'), 'Default namespace is app, so it equal app\\testing.');
  12.     $this->assertNull($option->get('hello'), 'The default namespace is app, so it equal app\\hello');
  13.     $option->set('hello', 'i am hello');
  14.     $this->assertSame($option->get('hello'), 'i am hello', 'The default namespace is app, so it equal app\\hello');
  16.     $this->assertSame($option->all(), [
  17.         'app' => [
  18.             'environment' => 'testing',
  19.             'hello'       => 'i am hello',
  20.         ],
  21.     ]);
  23.     // 当我们获取一个不存在的配置命名空间时，返回一个初始化的空数组
  24.     // hello namespace not app\hello
  25.     $this->assertSame($option->get('hello\\'), []);
  26.     $this->assertSame($option->get('hello\\*'), []);
  28.     $option->set('hello\\', ['foo' => ['sub' => 'bar']]);
  30.     $this->assertSame($option->get('hello\\foo.sub'), 'bar');
  32.     // namespace\sub.sub1.sub2
  33.     $option->set('cache\\time_preset.foo', 'bar');
  34.     $this->assertSame($option->get('cache\\time_preset.foo'), 'bar');
  35.     $this->assertNull($option->get('cache\\time_preset.foo2'));
  36. }

delete 删除配置

  1. public function testDelete(): void
  2. {
  3.     $data = [
  4.         'app' => [
  5.             'environment' => 'testing',
  6.             'debug'       => true,
  7.         ],
  8.         'cache' => [
  9.             'expire'      => 86400,
  10.             'time_preset' => [
  11.                 'foo' => 'bar',
  12.             ],
  13.         ],
  14.         'hello' => 'world',
  15.     ];
  17.     $option = new Option($data);
  18.     $option->delete('debug');
  20.     $this->assertSame($option->all(), [
  21.         'app' => [
  22.             'environment' => 'testing',
  23.         ],
  24.         'cache' => [
  25.             'expire'      => 86400,
  26.             'time_preset' => [
  27.                 'foo' => 'bar',
  28.             ],
  29.         ],
  30.         'hello' => 'world',
  31.     ]);
  33.     $option->delete('cache\\time_preset.foo');
  35.     $this->assertSame($option->all(), [
  36.         'app' => [
  37.             'environment' => 'testing',
  38.         ],
  39.         'cache' => [
  40.             'expire'      => 86400,
  41.             'time_preset' => [
  42.             ],
  43.         ],
  44.         'hello' => 'world',
  45.     ]);
  47.     // 删除命令空间会初始化该命名空间为空数组，不存在会创建一个空数组
  48.     $option->delete('hello\\');
  50.     $this->assertSame($option->all(), [
  51.         'app' => [
  52.             'environment' => 'testing',
  53.         ],
  54.         'cache' => [
  55.             'expire'      => 86400,
  56.             'time_preset' => [
  57.             ],
  58.         ],
  59.         'hello' => [],
  60.     ]);
  62.     $option->delete('world\\');
  64.     $this->assertSame($option->all(), [
  65.         'app' => [
  66.             'environment' => 'testing',
  67.         ],
  68.         'cache' => [
  69.             'expire'      => 86400,
  70.             'time_preset' => [
  71.             ],
  72.         ],
  73.         'hello' => [],
  74.         'world' => [],
  75.     ]);
  76. }

reset 重置配置

危险操作，一般没有必要调用。

  1. public function testReset(): void
  2. {
  3.     $data = [
  4.         'hello' => 'world',
  5.     ];
  7.     $option = new Option($data);
  9.     $this->assertSame($option->all(), [
  10.         'hello' => 'world',
  11.     ]);
  13.     // array
  14.     $option->reset(['foo' => 'bar']);
  15.     $this->assertSame($option->all(), [
  16.         'foo' => 'bar',
  17.     ]);
  19.     // set a namespace
  20.     $option->reset('foo');
  21.     $this->assertSame($option->all(), [
  22.         'foo' => [],
  23.     ]);
  25.     $option->reset('foo2');
  26.     $this->assertSame($option->all(), [
  27.         'foo'  => [],
  28.         'foo2' => [],
  29.     ]);
  31.     // reset all
  32.     $option->reset();
  33.     $this->assertSame($option->all(), []);
  34. }

数组访问配置对象

配置实现了 \ArrayAccess，可以通过以数组的方式访问配置对象，在服务提供者中经常运用。

  1. public function testArrayAccess(): void
  2. {
  3.     $data = [
  4.         'app' => [
  5.             'environment' => 'testing',
  6.             'debug'       => true,
  7.         ],
  8.         'cache' => [
  9.             'expire'      => 86400,
  10.             'time_preset' => [
  11.                 'foo' => 'bar',
  12.             ],
  13.         ],
  14.         'hello' => 'world',
  15.     ];
  17.     $option = new Option($data);
  19.     // get
  20.     $this->assertSame($option['cache\\time_preset.foo'], 'bar');
  22.     // remove
  23.     unset($option['cache\\time_preset.foo']);
  24.     $this->assertNull($option['cache\\time_preset.foo']);
  26.     // set
  27.     $option['cache\\foo'] = 'bar';
  28.     $this->assertSame($option['cache\\foo'], 'bar');
  30.     // has
  31.     $this->assertTrue(isset($option['hello\\']));
  32. }