sirix/sirix-config

Utils to load, parse and work with configuration on Mezzio projects

2.0.0 2025-11-22 20:29 UTC

Requires

• php: ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0
• cuyz/valinor: ^2.3
• laminas/laminas-servicemanager: ^3.22 || ^4.2
• laminas/laminas-stdlib: ^3.20

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8
• devster/ubench: ^2.1
• phpunit/phpunit: ^11.5
• psr/simple-cache: ^2.0
• roave/security-advisories: dev-master
• symfony/var-dumper: ^6.3

MIT

• Sirix

README

Utils to load, parse and work with configuration on Mezzio projects.

This library is based on the shlinkio/shlink-config project, with some modifications and extensions for our specific requirements.

Installation

Install this tool using composer.

composer install sirix/sirix-config

This library is also a mezzio module which provides its own ConfigProvider. Add it to your configuration to get everything automatically set up.

Included utils

• loadConfigFromGlob: Function which expects a glob pattern and loads and merges all config files that match it.

• EnvVarLoaderProvider: A config provider which loads the entries of the loaded config into env vars and always returns empty. Designed to be the first config provider in the pipeline.

• DottedAccessConfigAbstractFactory: An abstract factory that lets any config param to be fetched as a service by using the config.foo.bar notation.

• ValinorConfigFactory: A PSR-11 factory that lets you map arbitrary objects from arrays, using cuyz/valinor.

  In order to use it, you have to register the object to map as a service, and the ValinorConfigFactory with static access using the service that returns the raw array with the data as the static method name:

  <?php
  
  declare(strict_types=1);
  
  return [
      MyCoolOptions::class => [ValinorConfigFactory::class, 'config.foo.options'],
  ];

  It is useful to combine this factory with the DottedAccessConfigAbstractFactory.

Valinor cache configuration

ValinorConfigFactory supports an optional filesystem cache, configurable under the sirix_config.valinor key in your application config. Options:

• cache (bool): Enable/disable Valinor mapping cache. Default: false.
• cache_directory (string): Directory where cache files are stored. Default: data/cache/valinor.
• development_mode (bool): When true, enables file-watching cache to auto‑invalidate entries when source files change. Default: false.

Example config:

<?php

declare(strict_types=1);

return [
    'sirix_config' => [
        'valinor' => [
            'cache' => true,
            'cache_directory' => 'data/cache/valinor',
            'development_mode' => true,
        ],
    ],
];