Jaxon\Utils\Config\File\Yaml

Complexity

Total Complexity

4

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	read()	0	18	4

<?php

/**
 * YamlExtension.php - Jaxon config reader
 *
 * Read the config data from a YAML formatted config file.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2022 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

namespace Jaxon\Utils\Config\File;

use Jaxon\Utils\Config\Exception\YamlExtension;
use Jaxon\Utils\Config\Exception\FileAccess;
use Jaxon\Utils\Config\Exception\FileContent;

use function is_array;
use function realpath;
use function is_readable;
use function extension_loaded;
use function yaml_parse_file;

class Yaml
{
    /**
     * Read options from a YAML formatted config file
     *
     * @param string $sConfigFile The full path to the config file
     *
     * @return array
     * @throws YamlExtension
     * @throws FileAccess
     * @throws FileContent
     */
    public static function read(string $sConfigFile): array
    {
        $sConfigFile = realpath($sConfigFile);
        if(!extension_loaded('yaml'))
        {
            throw new YamlExtension();
        }
        if(!is_readable($sConfigFile))
        {
            throw new FileAccess($sConfigFile);
        }
        $aConfigOptions = yaml_parse_file($sConfigFile);
        if(!is_array($aConfigOptions))
        {
            throw new FileContent($sConfigFile);
        }

        return $aConfigOptions;
    }
}