SURFnet\VPN\Common\Config

Complexity

Total Complexity

13

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	defaultConfig()	0	4	1
A	hasSection()	0	8	2
A	getSection()	0	10	2
A	hasItem()	0	4	1
A	getItem()	0	8	2
A	fromFile()	0	8	2
A	toArray()	0	4	1
A	toFile()	0	5	1

<?php

/**
 * eduVPN - End-user friendly VPN.
 *
 * Copyright: 2016-2017, The Commons Conservancy eduVPN Programme
 * SPDX-License-Identifier: AGPL-3.0+
 */

namespace SURFnet\VPN\Common;

use SURFnet\VPN\Common\Exception\ConfigException;

class Config
{
    /** @var array */
    protected $configData;

    public function __construct(array $configData)
    {
        $this->configData = $configData;
        $this->configData = array_merge(static::defaultConfig(), $configData);
    }

    public static function defaultConfig()
    {
        return [];
    }

    public function hasSection($key)
    {
        if (!array_key_exists($key, $this->configData)) {
            return false;
        }

        return is_array($this->configData[$key]);
    }

    public function getSection($key)
    {
        if (false === $this->hasSection($key)) {
            throw new ConfigException(sprintf('"%s" is not a section', $key));
        }

        // do not return the parent object if we were subclassed, but an actual
        // "Config" object to avoid copying in the defaults if set
        return new self($this->configData[$key]);
    }

    public function hasItem($key)
    {
        return array_key_exists($key, $this->configData);
    }

    public function getItem($key)
    {
        if (false === $this->hasItem($key)) {
            throw new ConfigException(sprintf('item "%s" not available', $key));
        }

        return $this->configData[$key];
    }

    public static function fromFile($configFile)
    {
        if (false === @file_exists($configFile)) {
            throw new ConfigException(sprintf('unable to read "%s"', $configFile));
        }

        return new static(require $configFile);
    }

    public function toArray()
    {
        return $this->configData;
    }

    public static function toFile($configFile, array $configData, $mode = 0600)
    {
        $fileData = sprintf('<?php return %s;', var_export($configData, true));
        FileIO::writeFile($configFile, $fileData, $mode);
    }
}