Ubiquity\cache\CacheManager

Complexity

Total Complexity

31

Size/Duplication

Total Lines	227
Duplicated Lines	0 %

Test Coverage

Coverage

78.89%

Importance

Changes	2
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	startProd()	0	4	1
A	start()	0	6	1
A	getCacheDirectories()	0	18	2
B	initCache()	0	9	7
A	startProdFromCtrl()	0	5	1
A	getAbsoluteCacheDirectory()	0	2	1
A	clearCache()	0	5	2
A	getCacheSubDirectory()	0	2	1
A	getCacheInstance()	0	8	2
A	checkCache()	0	6	2
A	_getFiles()	0	6	2
A	initialGetCacheDirectory()	0	2	1
A	getAllRoutes()	0	3	1
A	_clearCache()	0	3	3
A	safeMkdir()	0	3	2
A	getCacheDirectory()	0	2	1
A	register()	0	34	1

<?php

/**
 * Cache managment
 */
namespace Ubiquity\cache;

use Ubiquity\cache\traits\ModelsCacheTrait;
use Ubiquity\cache\traits\RestCacheTrait;
use Ubiquity\cache\traits\RouterCacheTrait;
use Ubiquity\utils\base\UFileSystem;
use mindplay\annotations\AnnotationCache;
use mindplay\annotations\AnnotationManager;
use mindplay\annotations\Annotations;
use Ubiquity\controllers\Startup;

/**
 * Manager for caches (Router, Rest, models).
 * Ubiquity\cache$CacheManager
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.0.3
 *
 */
class CacheManager {
	use RouterCacheTrait,ModelsCacheTrait,RestCacheTrait;

	/**
	 *
	 * @var \Ubiquity\cache\system\AbstractDataCache
	 */
	public static $cache;
	private static $cacheDirectory;

	/**
	 * Starts the cache in dev mode, for generating the other caches
	 * Do not use in production
	 *
	 * @param array $config
	 */
	public static function start(&$config) {
		self::$cacheDirectory = self::initialGetCacheDirectory ( $config );
		$cacheDirectory = \ROOT . \DS . self::$cacheDirectory;
		Annotations::$config ['cache'] = new AnnotationCache ( $cacheDirectory . '/annotations' );
		self::register ( Annotations::getManager () );
		self::getCacheInstance ( $config, $cacheDirectory, '.cache' );
	}

	/**
	 * Starts the cache for production
	 *
	 * @param array $config
	 */
	public static function startProd(&$config) {
		self::$cacheDirectory = self::initialGetCacheDirectory ( $config );
		$cacheDirectory = \ROOT . \DS . self::$cacheDirectory;
		self::getCacheInstance ( $config, $cacheDirectory, '.cache' );
	}

	public static function startProdFromCtrl() {
		$config = &Startup::$config;
		$cacheD = \ROOT . \DS . ($config ['cache'] ['directory'] ??= 'cache' . \DS);
		$cacheSystem = $config ['cache'] ['system'] ?? 'Ubiquity\\cache\\system\\ArrayCache';
		self::$cache = new $cacheSystem ( $cacheD, '.cache', $config ['cache'] ['params'] ?? [ ]);
	}

	protected static function getCacheInstance(&$config, $cacheDirectory, $postfix) {
		if (! isset ( self::$cache )) {
			$cacheSystem = $config ['cache'] ['system'] ?? 'Ubiquity\\cache\\system\\ArrayCache';
			$cacheParams = $config ['cache'] ['params'] ?? [ ];

			self::$cache = new $cacheSystem ( $cacheDirectory, $postfix, $cacheParams );
		}
		return self::$cache;
	}

	private static function initialGetCacheDirectory(&$config) {
		return $config ['cache'] ['directory'] ??= 'cache' . \DS;
	}

	/**
	 * Returns the relative cache directory
	 *
	 * @return string
	 */
	public static function getCacheDirectory() {
		return self::$cacheDirectory;
	}

	/**
	 * Returns the absolute cache directory
	 *
	 * @return string
	 */
	public static function getAbsoluteCacheDirectory() {
		return \ROOT . \DS . self::$cacheDirectory;
	}

	/**
	 * Returns an absolute cache subdirectory
	 *
	 * @param string $subDirectory
	 * @return string
	 */
	public static function getCacheSubDirectory($subDirectory) {
		return \ROOT . \DS . self::$cacheDirectory . \DS . $subDirectory;
	}

	/**
	 * Checks the existence of cache subdirectories and returns an array of cache folders
	 *
	 * @param array $config
	 * @param boolean $silent
	 * @return string[]
	 */
	public static function checkCache(&$config, $silent = false) {
		$dirs = self::getCacheDirectories ( $config, $silent );
		foreach ( $dirs as $dir ) {
			self::safeMkdir ( $dir );
		}
		return $dirs;
	}

	/**
	 * Returns an associative array of cache folders (annotations, models, controllers, queries, views, seo, git, contents)
	 *
	 * @param array $config
	 * @param boolean $silent
	 * @return string[]
	 */
	public static function getCacheDirectories(&$config, $silent = false) {
		$cacheDirectory = self::initialGetCacheDirectory ( $config );
		$rootDS = \ROOT . \DS;
		if (! $silent) {
			echo "cache directory is " . UFileSystem::cleanPathname ( $rootDS . $cacheDirectory ) . "\n";
		}
		$cacheDirectory = $rootDS . $cacheDirectory . \DS;
		$modelsDir = str_replace ( "\\", \DS, $config ['mvcNS'] ['models'] );
		$controllersDir = str_replace ( "\\", \DS, $config ['mvcNS'] ['controllers'] );
		$annotationCacheDir = $cacheDirectory . 'annotations';
		$modelsCacheDir = $cacheDirectory . $modelsDir;
		$queriesCacheDir = $cacheDirectory . 'queries';
		$controllersCacheDir = $cacheDirectory . $controllersDir;
		$viewsCacheDir = $cacheDirectory . 'views';
		$seoCacheDir = $cacheDirectory . 'seo';
		$gitCacheDir = $cacheDirectory . 'git';
		$contentsCacheDir = $cacheDirectory . 'contents';
		return [ 'annotations' => $annotationCacheDir,'models' => $modelsCacheDir,'controllers' => $controllersCacheDir,'queries' => $queriesCacheDir,'views' => $viewsCacheDir,'seo' => $seoCacheDir,'git' => $gitCacheDir,'contents' => $contentsCacheDir ];
	}

	private static function safeMkdir($dir) {
		if (! \is_dir ( $dir ))
			return \mkdir ( $dir, 0777, true );
	}

	/**
	 * Deletes files from a cache type
	 *
	 * @param array $config
	 * @param string $type
	 */
	public static function clearCache(&$config, $type = 'all') {
		$cacheDirectories = self::checkCache ( $config );
		$cacheDirs = [ 'annotations','controllers','models','queries','views','contents' ];
		foreach ( $cacheDirs as $typeRef ) {
			self::_clearCache ( $cacheDirectories, $type, $typeRef );
		}
	}

	private static function _clearCache($cacheDirectories, $type, $typeRef) {
		if ($type === 'all' || $type === $typeRef)
			UFileSystem::deleteAllFilesFromFolder ( $cacheDirectories [$typeRef] );
	}

	/**
	 *
	 * @param array $config
	 * @param string $type
	 * @param boolean $silent
	 */
	public static function initCache(&$config, $type = 'all', $silent = false) {
		self::checkCache ( $config, $silent );
		self::start ( $config );
		if ($type === 'all' || $type === 'models')
			self::initModelsCache ( $config, false, $silent );
		if ($type === 'all' || $type === 'controllers')
			self::initRouterCache ( $config, $silent );
		if ($type === 'all' || $type === 'rest')
			self::initRestCache ( $config, $silent );
	}

	/**
	 * Returns an array of all defined routes, included REST routes
	 *
	 * @return array
	 */
	public static function getAllRoutes() {
		$routes = self::getControllerCache ();
		return \array_merge ( $routes, self::getControllerCache ( true ) );
	}

	/**
	 * Returns an array of files from type $type
	 *
	 * @param array $config
	 * @param string $type
	 * @param boolean $silent
	 * @return array
	 */
	protected static function _getFiles(&$config, $type, $silent = false) {
		$typeNS = $config ['mvcNS'] [$type];
		$typeDir = \ROOT . \DS . \str_replace ( "\\", \DS, $typeNS );
		if (! $silent)
			echo \ucfirst ( $type ) . ' directory is ' . \ROOT . $typeNS . "\n";
		return UFileSystem::glob_recursive ( $typeDir . \DS . '*.php' );
	}

	private static function register(AnnotationManager $annotationManager) {
		$annotationManager->registry = \array_merge ( $annotationManager->registry, [
																						'id' => 'Ubiquity\annotations\IdAnnotation',
																						'manyToOne' => 'Ubiquity\annotations\ManyToOneAnnotation',
																						'oneToMany' => 'Ubiquity\annotations\OneToManyAnnotation',
																						'manyToMany' => 'Ubiquity\annotations\ManyToManyAnnotation',
																						'joinColumn' => 'Ubiquity\annotations\JoinColumnAnnotation',
																						'table' => 'Ubiquity\annotations\TableAnnotation',
																						'database' => 'Ubiquity\annotations\DatabaseAnnotation',
																						'transient' => 'Ubiquity\annotations\TransientAnnotation',
																						'column' => 'Ubiquity\annotations\ColumnAnnotation',
																						'validator' => 'Ubiquity\annotations\ValidatorAnnotation',
																						'transformer' => 'Ubiquity\annotations\TransformerAnnotation',
																						'joinTable' => 'Ubiquity\annotations\JoinTableAnnotation',
																						'requestMapping' => 'Ubiquity\annotations\router\RouteAnnotation',
																						'route' => 'Ubiquity\annotations\router\RouteAnnotation',
																						'get' => 'Ubiquity\annotations\router\GetAnnotation',
																						'getMapping' => 'Ubiquity\annotations\router\GetAnnotation',
																						'post' => 'Ubiquity\annotations\router\PostAnnotation',
																						'postMapping' => 'Ubiquity\annotations\router\PostAnnotation',
																						'put' => 'Ubiquity\annotations\router\PutAnnotation',
																						'putMapping' => 'Ubiquity\annotations\router\PutAnnotation',
																						'patch' => 'Ubiquity\annotations\router\PatchAnnotation',
																						'patchMapping' => 'Ubiquity\annotations\router\PatchAnnotation',
																						'delete' => 'Ubiquity\annotations\router\DeleteAnnotation',
																						'deleteMapping' => 'Ubiquity\annotations\router\DeleteAnnotation',
																						'options' => 'Ubiquity\annotations\router\OptionsAnnotation',
																						'optionsMapping' => 'Ubiquity\annotations\router\OptionsAnnotation',
																						'var' => 'mindplay\annotations\standard\VarAnnotation',
																						'yuml' => 'Ubiquity\annotations\YumlAnnotation',
																						'rest' => 'Ubiquity\annotations\rest\RestAnnotation',
																						'authorization' => 'Ubiquity\annotations\rest\AuthorizationAnnotation',
																						'injected' => 'Ubiquity\annotations\di\InjectedAnnotation',
																						'autowired' => 'Ubiquity\annotations\di\AutowiredAnnotation' ] );
	}
}