N98\Magento\Application\ConfigLocator

Complexity

Total Complexity

15

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getUserConfigFile()	0	18	3
A	getProjectConfigFile()	0	17	3
A	getStopFileConfigFile()	0	21	4
B	getUserConfigFilePaths()	0	23	4

<?php
/*
 * this file is part of magerun
 *
 * @author Tom Klingenberg <https://github.com/ktomk>
 */

namespace N98\Magento\Application;

use InvalidArgumentException;
use N98\Util\OperatingSystem;
use RuntimeException;

/**
 * Class ConfigLocator
 *
 * Has all the information encoded to retrieve the various config files
 *
 * @package N98\Magento\Application
 */
class ConfigLocator
{
    /**
     * @var string
     */
    private $customConfigFilename;

    /**
     * @var string
     */
    private $magentoRootFolder;

    /**
     * ConfigLocator constructor.
     * @param string $configFilename
     * @param string $magentoRootFolder
     */
    public function __construct($configFilename, $magentoRootFolder)
    {
        $this->customConfigFilename = $configFilename;
        $this->magentoRootFolder = $magentoRootFolder;
    }

    /**
     * Obtain the user-config-file, it is placed in the homedir, e.g. ~/.n98-magerun2.yaml
     *
     * @return ConfigFile|null
     */
    public function getUserConfigFile()
    {
        $userConfigFile = null;

        $personalConfigFilePaths = $this->getUserConfigFilePaths();

        foreach ($personalConfigFilePaths as $personalConfigFilePath) {
            try {
                $userConfigFile = ConfigFile::createFromFile($personalConfigFilePath);
                $userConfigFile->applyVariables($this->magentoRootFolder);
                break;
            } catch (InvalidArgumentException $e) {
                $userConfigFile = null;
            }
        }

        return $userConfigFile;
    }

    /**
     * Obtain the project-config-file, it is placed in the magento app/etc dir, e.g. app/etc/n98-magerun2.yaml
     *
     * @return ConfigFile|null
     */
    public function getProjectConfigFile()
    {
        if (!strlen($this->magentoRootFolder)) {
            return;
        }

        $projectConfigFilePath = $this->magentoRootFolder . '/app/etc/' . $this->customConfigFilename;

        try {
            $projectConfigFile = ConfigFile::createFromFile($projectConfigFilePath);
            $projectConfigFile->applyVariables($this->magentoRootFolder);
        } catch (InvalidArgumentException $e) {
            $projectConfigFile = null;
        }

        return $projectConfigFile;
    }

    /**
     * Obtain the (optional) stop-file-config-file, it is placed in the folder of the stop-file, always
     * prefixed with a dot: stop-file-folder/.n98-magerun2.yaml
     *
     * @param string $magerunStopFileFolder
     * @return ConfigFile|null
     */
    public function getStopFileConfigFile($magerunStopFileFolder)
    {
        if (empty($magerunStopFileFolder)) {
            return;
        }

        $stopFileConfigFilePath = $magerunStopFileFolder . '/.' . $this->customConfigFilename;

        if (!file_exists($stopFileConfigFilePath)) {
            return;
        }

        try {
            $stopFileConfigFile = ConfigFile::createFromFile($stopFileConfigFilePath);
            $stopFileConfigFile->applyVariables($this->magentoRootFolder);
        } catch (InvalidArgumentException $e) {
            $stopFileConfigFile = null;
        }

        return $stopFileConfigFile;
    }

    /**
     * @return array
     */
    private function getUserConfigFilePaths()
    {
        $paths = array();

        $homeDirectory = OperatingSystem::getHomeDir();

        if (!strlen($homeDirectory)) {
            return $paths;
        }

        if (!is_dir($homeDirectory)) {
            throw new RuntimeException(sprintf("Home-directory '%s' is not a directory.", $homeDirectory));
        }

        $basename = $this->customConfigFilename;

        if (OperatingSystem::isWindows()) {
            $paths[] = $homeDirectory . '/' . $basename;
        }
        $paths[] = $homeDirectory . '/.' . $basename;

        return $paths;
    }
}