phpbu\App\Configuration\Loader\File

Complexity

Total Complexity

12

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getConfiguration()	0	15	1
A	setupAdapters()	0	6	2
A	getAdapter()	0	7	2
	getAdapterConfigs()	0	1	?
	setAppSettings()	0	1	?
	setLoggers()	0	1	?
	setBackups()	0	1	?
A	handleBootstrap()	0	4	1
A	toAbsolutePath()	0	4	1
A	getAdapterizedValue()	0	9	2
A	loadFile()	0	11	2

<?php
namespace phpbu\App\Configuration\Loader;

use phpbu\App\Adapter\Util;
use phpbu\App\Configuration;
use phpbu\App\Exception;
use phpbu\App\Factory as AppFactory;
use phpbu\App\Runner\Bootstrap;
use phpbu\App\Util\Cli;

/**
 * Base class for file based phpbu configuration.
 *
 * @package    phpbu
 * @subpackage App
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       https://phpbu.de/
 * @since      Class available since Release 2.1.2
 */
abstract class File
{
    /**
     * Path to config file.
     *
     * @var string
     */
    protected $filename;

    /**
     * Path to config file.
     *
     * @var array
     */
    protected $adapters;

    /**
     * Handling the bootstrapping.
     *
     * @var \phpbu\App\Configuration\Bootstrapper
     */
    protected $bootstrapper;

    /**
     * File constructor.
     *
     * @param string                                $file
     * @param \phpbu\App\Configuration\Bootstrapper $bootstrapper
     */
    public function __construct(string $file, Configuration\Bootstrapper $bootstrapper)
    {
        $this->filename     = $file;
        $this->bootstrapper = $bootstrapper;
    }

    /**
     * Returns the phpbu Configuration.
     *
     * @param  \phpbu\App\Factory $factory
     * @return \phpbu\App\Configuration
     * @throws \phpbu\App\Exception
     */
    public function getConfiguration(AppFactory $factory)
    {
        // create configuration first so the working directory is available for all adapters
        $configuration = new Configuration();
        $configuration->setFilename($this->filename);

        $this->setAppSettings($configuration);
        $this->handleBootstrap($configuration);
        $this->setupAdapters($factory);

        $this->setLoggers($configuration);
        $this->setBackups($configuration);

        return $configuration;
    }

    /**
     * Load all available config adapters.
     *
     * @param  \phpbu\App\Factory $factory
     * @throws \phpbu\App\Exception
     */
    protected function setupAdapters(AppFactory $factory)
    {
        foreach ($this->getAdapterConfigs() as $config) {
            $this->adapters[$config->name] = $factory->createAdapter($config->type, $config->options);
        }
    }

    /**
     * Return a registered adapter.
     *
     * @param  string $name
     * @return \phpbu\App\Adapter
     * @throws \phpbu\App\Exception
     */
    protected function getAdapter($name)
    {
        if (!isset($this->adapters[$name])) {
            throw new Exception('no adapter registered with name: ' . $name);
        }
        return $this->adapters[$name];
    }

    /**
     * Return list of adapter configs.
     *
     * @return array
     */
    abstract protected function getAdapterConfigs();

    /**
     * Set the phpbu application settings.
     *
     * @param  \phpbu\App\Configuration $configuration
     */
    abstract public function setAppSettings(Configuration $configuration);

    /**
     * Set the log configuration.
     *
     * @param  \phpbu\App\Configuration $configuration
     * @throws \phpbu\App\Exception
     */
    abstract public function setLoggers(Configuration $configuration);

    /**
     * Set the backup configurations.
     *
     * @param  \phpbu\App\Configuration $configuration
     * @throws \phpbu\App\Exception
     */
    abstract public function setBackups(Configuration $configuration);

    /**
     * Handles the bootstrap file inclusion.
     *
     * @param  \phpbu\App\Configuration $configuration
     * @throws \phpbu\App\Exception
     */
    protected function handleBootstrap(Configuration $configuration)
    {
        $this->bootstrapper->run($configuration);
    }

    /**
     * Converts a path to an absolute one if necessary.
     *
     * @param  string  $path
     * @param  boolean $useIncludePath
     * @return string
     */
    protected function toAbsolutePath($path, $useIncludePath = false)
    {
        return Cli::toAbsolutePath($path, dirname($this->filename), $useIncludePath);
    }

    /**
     * Return option value.
     * Checks if the value should be fetched from an Adapter, if not it just returns the value.
     *
     * @param  string $value
     * @return string
     * @throws \phpbu\App\Exception
     */
    protected function getAdapterizedValue($value)
    {
        foreach (Util::getAdapterReplacements($value) as $replacement) {
            $search  = $replacement['search'];
            $replace = $this->getAdapter($replacement['adapter'])->getValue($replacement['path']);
            $value   = str_replace($search, $replace, $value);
        }
        return $value;
    }

    /**
     * Load the file.
     *
     * @param  string $filename
     * @throws \phpbu\App\Exception
     * @return \stdClass
     */
    protected function loadFile($filename)
    {
        $reporting = error_reporting(0);
        $contents  = file_get_contents($filename);
        error_reporting($reporting);

        if ($contents === false) {
            throw new Exception(sprintf('Could not read "%s".', $filename));
        }
        return $contents;
    }
}