AframeVR\Core\Config

Complexity

Total Complexity

7

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	get()	0	4	1
A	getConfigRealPath()	0	4	1
A	configExists()	0	4	1
A	loadComposerJson()	0	4	2
A	defineVars()	0	7	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 27, 2016 - 6:28:45 AM
 * Contact      marko@okramlabs.com
 * @copyright   2016 Marko Kungla - https://github.com/mkungla
 * @license     The MIT License (MIT)
 * 
 * @category       AframeVR
 * @package        aframe-php
 * 
 * Lang         PHP (php version >= 7)
 * Encoding     UTF-8
 * File         Config.php
 * Code format  PSR-2 and 12
 * @link        https://github.com/mkungla/aframe-php
 ^ @issues      https://github.com/mkungla/aframe-php/issues
 * ********************************************************************
 * Contributors:
 * @author Marko Kungla <marko@okramlabs.com>
 * ********************************************************************
 * Comments:
 * @formatter:on */
namespace AframeVR\Core;

final class Config
{
    /**
     * Path to package composer.json
     * 
     * @var string|null
     */
    private $config_path;
    
    /**
     * Array with contents of composer.json
     * 
     * @var array|null
     */
    private $config_data;
    
    /**
     * Config arguments starting with (aframe-)
     * 
     * @var array|null
     */
    private $config_args;
    
    /**
     * Useful config vars
     * 
     * @var array
     */
    private $config_vars;
    
    /**
     * Configuration constructor
     * 
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        $this->loadComposerJson();
        $this->defineVars();
    }
    
    /**
     * Get configuration value by key
     * 
     * @param string $prop
     * @return string|null
     */
    public function get(string $prop)
    {
        return $this->config_vars[$prop] ?? null;
    }
    
    /**
     * Real path to aframe-php composer.json
     * 
     * @return string
     */
    protected function getConfigRealPath()
    {
        return $this->config_path ?? $this->config_path = dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'composer.json';
    }
    
    /**
     * Whether config file can be found
     * 
     * @return bool
     */
    protected function configExists()
    {
        return file_exists($this->getConfigRealPath());
    }
    
    /**
     * Load contents of aframe-php cmposer.json
     * 
     * @return array|null
     */
    protected function loadComposerJson()
    {
        return $this->configExists() ? $this->config_data = json_decode(file_get_contents($this->getConfigRealPath()),true) : null;
    }
    
    /**
     * Define Configuration constants
     * 
     * @return void
     */
    protected function defineVars()
    {
        $this->config_vars = array();
        $this->config_vars['DIR'] = $this->config_data['config']['aframe-dir'] ?? 'public/aframe';
        $this->config_vars['URL'] = $this->config_data['config']['aframe-url'] ?? '/aframe';
        $this->config_vars['CDN'] = $this->config_data['config']['aframe-cdn'] ?? 'https://aframe.io/releases/latest/aframe.min.js';
    }
}