Passed
Push — master ( 2492ae...ecf533 )
by Jean-Christophe
11:25
created

ModelsCacheTrait::getModelsDatabases()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 2.0625

Importance

Changes 1
Bugs 0 Features 1
Metric Value
eloc 3
dl 0
loc 5
ccs 3
cts 4
cp 0.75
rs 10
c 1
b 0
f 1
cc 2
nc 2
nop 0
crap 2.0625
1
<?php
2
3
/**
4
 * Cache traits
5
 */
6
namespace Ubiquity\cache\traits;
7
8
use Ubiquity\orm\parser\ModelParser;
9
use Ubiquity\cache\ClassUtils;
10
use Ubiquity\contents\validation\ValidatorsManager;
11
use Ubiquity\orm\parser\Reflexion;
12
use Ubiquity\exceptions\UbiquityException;
13
use Ubiquity\orm\OrmUtils;
14
15
/**
16
 *
17
 * Ubiquity\cache\traits$ModelsCacheTrait
18
 * This class is part of Ubiquity
19
 *
20
 * @author jcheron <[email protected]>
21
 * @version 1.0.3
22
 * @property \Ubiquity\cache\system\AbstractDataCache $cache
23
 */
24
trait ModelsCacheTrait {
25
26
	abstract protected static function _getFiles(&$config, $type, $silent = false);
27
	private static $modelsDatabaseKey = 'models' . \DIRECTORY_SEPARATOR . '_modelsDatabases';
28
29 36
	public static function createOrmModelCache($classname) {
30 36
		$key = self::getModelCacheKey ( $classname );
31 36
		if (isset ( self::$cache )) {
32 36
			$p = new ModelParser ();
33 36
			$p->parse ( $classname );
34 36
			self::$cache->store ( $key, $p->asArray (), 'models' );
35 36
			return self::$cache->fetch ( $key );
36
		}
37
	}
38
39 42
	public static function getOrmModelCache($classname) {
40 42
		return self::$cache->fetch ( self::getModelCacheKey ( $classname ) );
41
	}
42
43 77
	public static function getModelCacheKey($classname) {
44 77
		return \str_replace ( "\\", \DS, $classname );
45
	}
46
47 12
	public static function modelCacheExists($classname) {
48 12
		$key = self::getModelCacheKey ( $classname );
49 12
		if (isset ( self::$cache ))
50 12
			return self::$cache->exists ( $key );
51
		return false;
52
	}
53
54 35
	public static function initModelsCache(&$config, $forChecking = false, $silent = false) {
55 35
		$modelsDb = [ ];
56 35
		$files = self::getModelsFiles ( $config, $silent );
57 35
		foreach ( $files as $file ) {
58 35
			if (is_file ( $file )) {
59 35
				$model = ClassUtils::getClassFullNameFromFile ( $file );
60 35
				if (! $forChecking) {
61 35
					self::createOrmModelCache ( $model );
62 35
					$db = 'default';
63 35
					$ret = Reflexion::getAnnotationClass ( $model, '@database' );
64 35
					if (\sizeof ( $ret ) > 0) {
65 35
						$db = $ret [0]->name;
66 35
						if (! isset ( $config ['database'] [$db] )) {
67
							throw new UbiquityException ( $db . ' connection is not defined in config array' );
68
						}
69
					}
70 35
					$modelsDb [$model] = $db;
71 35
					ValidatorsManager::initClassValidators ( $model );
72
				}
73
			}
74
		}
75 35
		if (! $forChecking) {
76 35
			self::$cache->store ( self::$modelsDatabaseKey, $modelsDb, 'models' );
77
		}
78 35
		if (! $silent) {
79 6
			echo "Models cache reset\n";
80
		}
81 35
	}
82
83
	/**
84
	 * Checks if the models cache is up to date
85
	 *
86
	 * @param array $config
87
	 * @return boolean|array
88
	 */
89 12
	public static function modelsCacheUpdated(&$config) {
90 12
		$result = false;
91 12
		$files = self::getModelsFiles ( $config, true );
92 12
		foreach ( $files as $file ) {
93 12
			if (\is_file ( $file )) {
94 12
				$model = ClassUtils::getClassFullNameFromFile ( $file );
95 12
				$p = new ModelParser ();
96 12
				$p->parse ( $model );
97 12
				if (! self::modelCacheExists ( $model ) || self::getOrmModelCache ( $model ) != $p->asArray ()) {
98
					$result [$model] = true;
99
				}
100
			}
101
		}
102 12
		return $result;
103
	}
104
105
	/**
106
	 * Returns an array of files corresponding to models
107
	 *
108
	 * @param array $config
109
	 * @param boolean $silent
110
	 * @return array
111
	 */
112 50
	public static function getModelsFiles(&$config, $silent = false) {
113 50
		return self::_getFiles ( $config, 'models', $silent );
114
	}
115
116
	/**
117
	 * Returns an array of the models class names
118
	 *
119
	 * @param array $config
120
	 * @param boolean $silent
121
	 * @return string[]
122
	 */
123 6
	public static function getModels(&$config, $silent = false, $databaseOffset = 'default') {
124 6
		$result = [];
125 6
		$files = self::getModelsFiles($config, $silent);
126 6
		foreach ($files as $file) {
127 6
			$className = ClassUtils::getClassFullNameFromFile($file);
128 6
			if (\class_exists($className, true)) {
129 6
				$db = 'default';
130 6
				$ret = Reflexion::getAnnotationClass($className, '@database');
131 6
				if (\sizeof($ret) > 0) {
132 6
					$db = $ret[0]->name;
133
				}
134 6
				if ($db === $databaseOffset) {
135 6
					$result[] = $className;
136
				}
137
			}
138
		}
139 6
		return $result;
140
	}
141
142 43
	public static function getModelsDatabases() {
143 43
		if (self::$cache->exists ( self::$modelsDatabaseKey )) {
144 43
			return self::$cache->fetch ( self::$modelsDatabaseKey );
145
		}
146
		return [ ];
147
	}
148
149
	/**
150
	 * Preloads models metadatas.
151
	 * To use only with async servers (Swoole, Workerman)
152
	 *
153
	 * @param array $config
154
	 * @param string $offset
155
	 * @param ?array $models
156
	 */
157
	public static function warmUpModels(&$config, $offset = 'default', $models = null) {
158
		$models ??= self::getModels ( $config, true, $offset );
159
		foreach ( $models as $model ) {
160
			OrmUtils::getModelMetadata ( $model );
161
			Reflexion::getPropertiesAndValues ( new $model () );
162
		}
163
	}
164
}