alex-kalanis / kw_confs
用于访问KWCMS设置的配置
v2.0.0
2024-04-08 23:45 UTC
Requires
- php: >=7.4.0
- alex-kalanis/kw_paths: >=4.0 <5
- alex-kalanis/kw_routed_paths: >=3.0 <4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- phpstan/phpstan: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: >=8.0 <=9
- shipmonk/composer-dependency-analyser: ^1.4
README
在KWCMS树中定义使用的配置。解析它们并返回。
PHP安装
composer.phar require alex-kalanis/kw_confs
(如果您不熟悉Composer,请参阅 Composer文档)
此包包含来自KWCMS启动文件的示例文件。将其用作参考。
此配置启动器与KWCMS模块相关联。在KWCMS外部使用它意味着您需要了解模块系统的树结构以及在那里定位配置。
这个想法是关于通过它们的名称(单个命名空间)以及模块名称来区分的配置,这样您就可以在多个模块中使用相同的键,但具有略微不同的含义。
基本配置本身是一个简单的PHP文件,其中定义了一个数组变量 "$config",在其中存储着类似于普通PHP数组中的键值对。您需要指定模块 - 当配置加载时,它将自动设置到内容数组中。
还可以使用您自己的加载器,该加载器将根据您的规则读取您的配置文件。因此,您可以连接从数据库或INI文件读取配置,并且所有操作都将保持相同的方式。只需注意,加载器的输入是模块和有时是配置名称,输出是键值对的数组,这些键值对将作为模块的主要键设置到配置数组中。
示例
对于“内容的一部分图像”模块,它返回了数组 ['您的内部配置键' => '此值将被获取', '另一个键' => false, ]
print \kalanis\kw_confs\Config::get('image as part of content', 'your internal system key', 'dummy');
它返回 'dummy'
print \kalanis\kw_confs\Config::get('image as part of content', 'your internal config key', 'nope');
它返回 '此值将被获取'
最佳用法是在控制器类中跨其他模块使用 - 您只需使用您的键填充 Config::get()
。您可以创建一个完整的类,该类返回所需的配置,该配置是 IConf
的实例,然后将其传递给语言加载器。