Todolo\Helper\ConfigHelper

Complexity

Total Complexity

5

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

75%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getStandardConfig()	0	10	1
A	validateConfig()	0	21	4

<?php

declare(strict_types=1);

namespace Todolo\Helper;

use Exception;

class ConfigHelper
{
    /**
     * @return array<string, array<int, string>|bool>
     */
    public function getStandardConfig(): array
    {
        return [
            'dirs_to_check' => [
                'src',
            ],
            // show
            'show_empty_dir' => false,
            'show_files_with_no_todos' => false,
            'show_no_files_info' => true,
        ];
    }

    /**
     * @param array<int|string, mixed> $config
     *
     * @throws Exception if a required field is not set
     */
    public function validateConfig(array $config): void
    {
        /*
         * check required config
         */
        foreach ([
            'dirs_to_check',
            'show_empty_dir',
            'show_files_with_no_todos',
            'show_no_files_info',
        ] as $key) {
            if (!isset($config[$key])) {
                throw new Exception('Field "'.$key.'" not set in config.');
            }
        }

        /*
         * setting: dirs_to_check
         */
        if (!\is_array($config['dirs_to_check'])) {
            throw new Exception('Field "dirs_to_check" is not of type array.');
        }
    }
}