gacela-project / gacela-yaml-config-reader

0.1.0 2026-08-17 19:46 UTC

Requires

• php: >=8.3
• gacela-project/gacela: ^2.4
• symfony/yaml: ^6.4 || ^7.0 || ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.95
• infection/infection: ^0.34
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.5 || ^12.0
• psalm/plugin-phpunit: ^0.19.7
• symfony/var-dumper: ^6.4 || ^7.0 || ^8.0
• vimeo/psalm: ^6.16

MIT

• Jose Maria Valera Reales
• Jesus Valera Reales

• php
• modular
• kernel

Published on Packagist.org on 2026-08-17 20:48 UTC

README

Load yaml/yml configuration files for your Gacela projects.

composer require gacela-project/gacela-yaml-config-reader

Requirements

PHP	>=8.3
gacela-project/gacela	^2.4
symfony/yaml	^6.4 || ^7.0 || ^8.0

Gacela 2.0 raised its own PHP floor to 8.3, so this package cannot be used on an older runtime. Earlier versions of this package declared php: ^8.0, <8.3 and gacela-project/gacela: *, a pair that could only ever resolve against Gacela 1.x — if you are still there, keep using one of those. See Gacela's upgrade guide for what moving to 2.x involves.

Setup

You can define the reader configuration either in the Gacela::bootstrap() or in a gacela.php file.

Option A)

Define the configuration in a gacela.php file in the root of your project (recommended way):

<?php # gacela.php

use Gacela\Framework\Bootstrap\GacelaConfig;
use Gacela\Framework\Config\ConfigReader\YamlConfigReader;

return static function (GacelaConfig $config): void {
    $config->addAppConfig('config/*.{yaml,yml}', 'config/local.yaml', YamlConfigReader::class);
};

Option B)

Define all configuration on the fly in the bootstrap itself.

<?php  # public/index.php

use Gacela\Framework\Bootstrap\GacelaConfig;
use Gacela\Framework\Config\ConfigReader\YamlConfigReader;
use Gacela\Framework\Gacela;

$config = static function (GacelaConfig $config): void {
    $config->addAppConfig('config/*.{yaml,yml}', 'config/local.yaml', YamlConfigReader::class);
};

Gacela::bootstrap($appRootDir, $config);

You can define more than one ConfigReader at once.

$config = static function (GacelaConfig $config): void {
    $config->addAppConfig('config/*.{yaml,yml}', 'config/local.yaml', YamlConfigReader::class);
    $config->addAppConfig('config/*.php', 'config/local.php');
    $config->addAppConfig('config/*.custom', '', CustomConfigReader::class);
}