Organizing Configurations with Laravel's Config Repository

[pronist]

Jigsaw's configuration is relatively easy since everything can be done in config.php, but I wondered if we could manage it more cleanly by separating it, similar to Laravel.

Installation

mkdir my-app
cd my-app

composer require tightenco/jigsaw

vendor/bin/jigsaw init
npm install

When initializing Jigsaw, the default configuration looks like this:

<?php

return [
    'production' => false,
    'baseUrl' => '',
    'title' => 'Jigsaw',
    'description' => 'Website description.',
    'collections' => [],
];

Configuration

We can categorize the configuration into app settings like production, baseUrl, title, description; collections like collections; and additional page variables or helper functions. While managing helper functions in helpers.php works well, what if we separated the other parts?

Let's use Laravel Configuration to separate them.

composer require illuminate/config

Since we'll be adding a dedicated class for managing configurations, let's add PSR-4 settings to composer.json.

"autoload": {
    "psr-4": {
        "App\\": "app"
    }
},

Config

Before creating the Configuration class, let's first create a config directory and configuration files. We'll separate production-specific settings.

mkdir config
mkdir config/production

touch config/app.php
touch config/collections.php
touch config/variables.php

touch config/production/app.php

config/app.php

<?php

return [
    'production' => false,
    'baseUrl' => '',
    'title' => 'Jigsaw',
    'description' => 'Website description.'
];

config/collections.php

<?php

return [];

config/variables.php

<?php

return [];

config/production/app.php

<?php

return [
    'production' => true,
];

Configuration

The Configuration class is a dedicated class for managing settings.

touch app/Configuration.php

In Configuration, we use Laravel's Config Repository to manage the settings. We initialize the Repository for the settings, specify the path for the configuration files in the constructor, and load them with Configuration::load(). The Configuration::getConfig() method is used in config.php and config.production.php to retrieve the merged settings from the Repository as an array.

<?php

namespace App;

use Illuminate\Config\Repository;
use Illuminate\Contracts\Filesystem\FileNotFoundException;
use Illuminate\Filesystem\Filesystem;

class Configuration
{
    private Repository $repository;

    public function __construct(?string $mode = null)
    {
        $path = implode(
            '/',
            [ dirname(__DIR__), 'config', $mode ?: '.', '*.php']
        );

        $this->load($path);
    }

    private function load(string $path): void
    {
        $this->repository = new Repository();

        $fs = new Filesystem();

        foreach ($fs->glob($path) as $filepath) {
            $key = pathinfo(
                $filepath,
                PATHINFO_FILENAME
            );

            $this->repository[$key] = $fs->getRequire($filepath);
        }
    }

    public function get(string $key): mixed
    {
        return $this->repository->get($key);
    }

    public function set(string $key, mixed $value): void
    {
        $this->repository->set($key, $value);
    }

    public function getConfig(): array
    {
        $config = $this->get('app');

        if ($variables = $this->get('variables')) {
            $config = array_merge($config, $variables);
        }

        if ($collections = $this->get('collections')) {
            $config = array_merge($config, [ 'collections' => $collections ]);
        }

        return $config;
    }
}

Now, simply use Configuration::getConfig() in config.php and config.production.php.

config.php

<?php

return new \App\Configuration()->getConfig();

config.production.php

<?php

return new \App\Configuration(
    mode: 'production'
)->getConfig();