fi1a/package-config

Управление конфигурацией пакетов

dev-master 2023-02-18 08:59 UTC

Requires

• php: ^7.3 || ^8
• composer-plugin-api: ^2.0
• ext-json: *
• fi1a/collection: ^2.0
• fi1a/config: ^2.1
• fi1a/dependency-injection: ^1.0
• fi1a/facade: dev-master
• fi1a/filesystem: ^1.0

Requires (Dev)

• captainhook/captainhook: ^5.4
• composer/composer: ^2.0
• phpunit/phpunit: ^9.3
• slevomat/coding-standard: ^6.3
• squizlabs/php_codesniffer: ^3.5
• vimeo/psalm: ^4.3

MIT

• Fi1a

README

Предоставляет возможность использовать конфигурационные файлы в вашем пакете. Объединяет все конфигурационные файлы из установленных пакетов в один и предоставляет доступ по группам. Данный пакет реализует систему плагинов Composer, которая обеспечивает сборку конфигураций непосредственно при установке нового пакета.

Установка

Установить этот пакет можно как зависимость, используя Composer.

composer require fi1a/package-config

Использование

Данный пакет представляет собой плагин Composer. После установки или удаления пакета вызываются обработчики событий, которые запускают сборку конфигураций:

• проверяется наличие ключа package-config в секции extra файла composer.json установленных пакетов;
• формируется карта конфигурационных файлов всех пакетов и сохраняется в файл vendor/fi1a/package-config/runtime/.map.json.

Ключ package-config в секции extra файла composer.json может иметь слудующую структуру:

{
  "extra": {
    "package-config": {
      "params": "params.php",
      "web": "web.php",
      "modules": [
        {
          "sort": 1000,
          "file": "modules2.php"
        },
        {
          "sort": 900,
          "file": "modules1.php"
        }
      ]
    }
  }
}

Ключи params, web и modules являются названием группы конфигураций. По данному параметру группируются значения в объединенной конфигурации (например конфигурация из файла params.php будет записана в группу params и будет доступна по данному значению).

Значения params.php, web.php, modules1.php и modules2.php являются названиями файлов конфигурации в директории configs.

Значение ключа sort представляет собой сортировку по которой будут отсортированы в порядке возрастания файлы конфигураций перед объединением. Соответсвенно данный параметр влияет из какого конфигурационного файла значение будет перезаписано. По умолчанию для пакета сортировка равна 500, а для корневого пакета равна 1000.

Файлы конфигураций пакетов должны располагаться в папке configs вашего пакета.

Для доступа к значениям конфигурационных файлов можно воспользоваться хелпером config(string $group):

config('params')->get('foo:bar:baz', 'defaultValue');

Хелпер возвращает объект Fi1a\Config\ConfigValuesInterface из пакета fi1a/config Данный класс позволяет получать доступ к ключам массива по пути (foo:bar:baz).

Команды

Плагин добавляет команды package-config-publish и package-config-rebuild в Composer.

Команда package-config-publish публикует конфигурационные файлы пакета в директорию configsкорневого пакета:

composer package-config-publish <package-name> [files]

Опубликовать все файлы конфигураций пакета:

composer package-config-publish foo/bar

Опубликовать указанные файлы конфигураций пакета:

composer package-config-publish foo/bar params.php web.php

Команда package-config-rebuild запускает сборку конфигураций. Она будет полезна при добавлении нового файла конфигурации или изменение сортировки, когда требуется пересоздать файл карты конфигурационных файлов.

composer package-config-rebuild