BfwSql\UsedClass

Complexity

Total Complexity

5

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfig()	0	3	1
A	obtainClassNameToUse()	0	3	1
A	getInstance()	0	8	2
A	__construct()	0	3	1

<?php

namespace BfwSql;

/**
 * To obtain the class name to used for class declared into a config file
 * 
 * @package bfw-sql
 * @author Vermeulen Maxime <bulton.fr@gmail.com>
 * @version 2.0
 */
class UsedClass
{
    /**
     * @var \BfwSql\UsedClass|null $instance UsedClass instance (Singleton)
     */
    protected static $instance;
    
    /**
     * @var \BFW\Config $config The config instance for the current module
     */
    protected $config;
    
    /**
     * protected for Singleton pattern
     * 
     * @param \BFW\Config $config The config instance for the current module
     */
    protected function __construct(\BFW\Config $config)
    {
        $this->config = $config;
    }
    
    /**
     * Get the UsedClass instance (Singleton pattern)
     * 
     * @param \BFW\Config|null $config The config instance for the module
     * 
     * @return \BfwSql\UsedClass
     */
    public static function getInstance($config = null): \BfwSql\UsedClass
    {
        if (self::$instance === null) {
            $class = get_called_class();
            self::$instance = new $class($config);
        }
        
        return self::$instance;
    }
    
    /**
     * Getter accessor to config property
     * 
     * @return \BFW\Config
     */
    public function getConfig(): \BFW\Config
    {
        return $this->config;
    }

    /**
     * Obtain the class name declared into config file "class.php" for a key
     * 
     * @param string $classNameKey The class name key into the config file
     * 
     * @return string
     */
    public function obtainClassNameToUse(string $classNameKey): string
    {
        return $this->config->getValue($classNameKey, 'class.php');
    }
}