Ubiquity\controllers\traits\StartupConfigTrait

Complexity

Total Complexity

39

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Test Coverage

Coverage

73.68%

Importance

Changes	4
Bugs	1	Features	1

22 Methods

Rating	Name	Duplication	Size	Complexity
A	reloadServices()	0	3	1
A	setCtrlNS()	0	2	1
A	getHttpInstance()	0	5	2
A	getSessionInstance()	0	5	2
A	reloadConfig()	0	6	1
A	checkModelsConfig()	0	9	2
A	updateConfig()	0	5	2
A	saveConfig()	0	13	4
A	checkDbConfig()	0	10	2
A	setHttpInstance()	0	2	1
A	isValidControllerAction()	0	5	2
A	setSessionInstance()	0	2	1
A	isValidUrl()	0	15	5
A	getNS()	0	2	1
A	setConfig()	0	2	1
A	getConfig()	0	2	1
A	getModelsCompletePath()	0	2	1
A	resetActiveDomainBase()	0	2	1
A	needsKeyInConfigArray()	0	4	4
A	setActiveDomainBase()	0	5	2
A	getActiveDomainBase()	0	2	1
A	getModelsDir()	0	2	1

<?php

namespace Ubiquity\controllers\traits;

use Ubiquity\controllers\Router;
use Ubiquity\orm\DAO;
use Ubiquity\utils\base\CodeUtils;
use Ubiquity\utils\base\UArray;
use Ubiquity\utils\base\UFileSystem;
use Ubiquity\utils\base\UString;
use Ubiquity\utils\http\foundation\AbstractHttp;
use Ubiquity\utils\http\foundation\PhpHttp;
use Ubiquity\utils\http\session\AbstractSession;
use Ubiquity\utils\http\session\PhpSession;

/**
 * Ubiquity\controllers\traits$StartupConfigTrait
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.1.6
 *
 */
trait StartupConfigTrait {
	public static $config;
	protected static $ctrlNS;
	protected static $httpInstance;
	protected static $sessionInstance;
	protected static $activeDomainBase='';

	public static function getConfig(): array {
		return self::$config;
	}

	public static function setConfig($config): void {
		self::$config = $config;
	}

	public static function getModelsDir(): string {
		return str_replace('\\',\DS,self::getNS('models'));
	}

	public static function getModelsCompletePath(): string {
		return \ROOT . \DS . self::getModelsDir ();
	}

	protected static function needsKeyInConfigArray(&$result, $array, $needs): void {
		foreach ( $needs as $need ) {
			if (! isset ( $array [$need] ) || UString::isNull ( $array [$need] )) {
				$result [] = $need;
			}
		}
	}

	public static function getNS($part = 'controllers'): string {
		return self::$activeDomainBase.((self::$config ['mvcNS'] [$part])??$part)."\\";
	}

	protected static function setCtrlNS(): string {
		return self::$ctrlNS = self::getNS ();
	}

	public static function checkDbConfig($offset = 'default'): array {
		$config = self::$config;
		$result = [ ];
		$needs = [ 'type','dbName','serverName' ];
		if (! isset ( $config ['database'] )) {
			$result [] = 'database';
		} else {
			self::needsKeyInConfigArray ( $result, DAO::getDbOffset ( $config, $offset ), $needs );
		}
		return $result;
	}

	public static function checkModelsConfig(): array {
		$config = self::$config;
		$result = [ ];
		if (! isset ( $config ['mvcNS'] )) {
			$result [] = 'mvcNS';
		} else {
			self::needsKeyInConfigArray ( $result, $config ['mvcNS'], [ 'models' ] );
		}
		return $result;
	}

	public static function reloadConfig(): array {
		$appDir = \dirname ( \ROOT );
		$filename = $appDir . '/app/config/config.php';
		self::$config = include ($filename);
		self::startTemplateEngine ( self::$config );
		return self::$config;
	}

	public static function reloadServices(): void {
		$config = self::$config; // used in services.php
		include \ROOT . 'config/services.php';
	}

	public static function saveConfig(array $contentArray) {
		$appDir = \dirname ( \ROOT );
		$filename = $appDir . '/app/config/config.php';
		$oldFilename = $appDir . '/app/config/config.old.php';
		$content = "<?php\nreturn " . UArray::asPhpArray ( $contentArray, 'array', 1, true ) . ";";
		if (CodeUtils::isValidCode ( $content )) {
			if (! \file_exists ( $filename ) || \copy ( $filename, $oldFilename )) {
				return UFileSystem::save ( $filename, $content );
			}
		} else {
			throw new \RuntimeException ( 'Config contains invalid code' );
		}
		return false;
	}

	public static function updateConfig(array $content) {
		foreach ( $content as $k => $v ) {
			self::$config [$k] = $v;
		}
		return self::saveConfig ( self::$config );
	}

	public static function getHttpInstance(): AbstractHttp {
		if (! isset ( self::$httpInstance )) {
			self::$httpInstance = new PhpHttp ();
		}
		return self::$httpInstance;
	}

	public static function setHttpInstance(AbstractHttp $httpInstance): void {
		self::$httpInstance = $httpInstance;
	}

	public static function getSessionInstance(): AbstractSession {
		if (! isset ( self::$sessionInstance )) {
			self::$sessionInstance = new PhpSession ();
		}
		return self::$sessionInstance;
	}

	public static function setSessionInstance(AbstractSession $sessionInstance): void {
		self::$sessionInstance = $sessionInstance;
	}

	public static function isValidUrl(string $url): bool {
		$u = self::parseUrl ( $url );
		if (\is_array ( Router::getRoutes () ) && ($ru = Router::getRoute ( $url, false, self::$config ['debug'] ?? false)) !== false) {
			if (\is_array ( $ru )) {
				if (\is_string ( $ru ['controller'] )) {
					return static::isValidControllerAction ( $ru ['controller'], $ru ['action'] ?? 'index');
				} else {
					return \is_callable ( $ru );
				}
			}
		} else {
			$u [0] = self::$ctrlNS . $u [0];
			return static::isValidControllerAction ( $u [0], $u [1] ?? 'index');
		}
		return false;
	}

	private static function isValidControllerAction(string $controller, string $action): bool {
		if (\class_exists ( $controller )) {
			return \method_exists ( $controller, $action );
		}
		return false;
	}

	/**
	 * Sets the active domain for a Domain Driven Design approach.
	 * @param string $domain The new active domain name
	 * @param string $base The base folder for domains
	 */
	public static function setActiveDomainBase(string $domain,string $base='domains'): void {
			self::$activeDomainBase = $base . '\\' . \trim($domain, '\\') . '\\';
			if(isset(self::$templateEngine)){
				$viewFolder=\realpath( \str_replace('\\',\DS,\ROOT.self::$activeDomainBase.'views'));
				self::$templateEngine->setPaths([$viewFolder],$domain);
			}
	}

	public static function getActiveDomainBase(): string {
		return self::$activeDomainBase;
	}

	public static function resetActiveDomainBase(): void {
		self::$activeDomainBase='';
	}
}