psfs /
core
| Total Complexity | 66 |
| Total Lines | 369 |
| Duplicated Lines | 0 % |
| Coverage | 87.42% |
| Changes | 26 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Router often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Router, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class Router |
||
| 29 | { |
||
| 30 | use SingletonTrait; |
||
| 31 | use ModulesTrait; |
||
| 32 | |||
| 33 | const PSFS_BASE_NAMESPACE = 'PSFS'; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var array |
||
| 37 | */ |
||
| 38 | private $routing = []; |
||
| 39 | /** |
||
| 40 | * @var array |
||
| 41 | */ |
||
| 42 | private $slugs = []; |
||
| 43 | /** |
||
| 44 | * @var Cache $cache |
||
| 45 | */ |
||
| 46 | private $cache; |
||
| 47 | /** |
||
| 48 | * @var int |
||
| 49 | */ |
||
| 50 | protected $cacheType = Cache::JSON; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Router constructor. |
||
| 54 | * @throws GeneratorException |
||
| 55 | * @throws ConfigException |
||
| 56 | * @throws InvalidArgumentException |
||
| 57 | * @throws ReflectionException |
||
| 58 | */ |
||
| 59 | 2 | public function __construct() |
|
| 60 | { |
||
| 61 | 2 | $this->cache = Cache::getInstance(); |
|
| 62 | 2 | $this->initializeFinder(); |
|
| 63 | 2 | $this->init(); |
|
| 64 | 2 | } |
|
| 65 | |||
| 66 | /** |
||
| 67 | * @throws GeneratorException |
||
| 68 | * @throws ConfigException |
||
| 69 | * @throws InvalidArgumentException |
||
| 70 | * @throws ReflectionException |
||
| 71 | */ |
||
| 72 | 3 | public function init() |
|
| 81 | 3 | } |
|
| 82 | |||
| 83 | /** |
||
| 84 | * @throws GeneratorException |
||
| 85 | * @throws ConfigException |
||
| 86 | * @throws InvalidArgumentException |
||
| 87 | * @throws ReflectionException |
||
| 88 | */ |
||
| 89 | 3 | private function debugLoad() |
|
| 90 | { |
||
| 91 | 3 | Logger::log('Begin routes load'); |
|
| 92 | 3 | $this->hydrateRouting(); |
|
| 93 | 3 | $this->simpatize(); |
|
| 94 | 3 | Logger::log('End routes load'); |
|
| 95 | 3 | } |
|
| 96 | |||
| 97 | /** |
||
| 98 | * @return array |
||
| 99 | */ |
||
| 100 | 1 | public function getSlugs() |
|
| 101 | { |
||
| 102 | 1 | return $this->slugs; |
|
| 103 | } |
||
| 104 | |||
| 105 | /** |
||
| 106 | * @return array |
||
| 107 | */ |
||
| 108 | 2 | public function getRoutes() |
|
| 109 | { |
||
| 110 | 2 | return $this->routing; |
|
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Method that extract all routes in the platform |
||
| 115 | * @return array |
||
| 116 | */ |
||
| 117 | 1 | public function getAllRoutes() |
|
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * @param string|null $route |
||
| 130 | * |
||
| 131 | * @return string HTML |
||
| 132 | * @throws Exception |
||
| 133 | */ |
||
| 134 | 5 | public function execute($route) |
|
| 135 | { |
||
| 136 | 5 | Inspector::stats('[Router] Executing the request', Inspector::SCOPE_DEBUG); |
|
| 137 | 5 | $code = 404; |
|
|
Unused Code
introduced
by
|
|||
| 138 | try { |
||
| 139 | //Search action and execute |
||
| 140 | 5 | return $this->searchAction($route); |
|
| 141 | 4 | } catch (AccessDeniedException $e) { |
|
| 142 | 1 | Logger::log(t('Solicitamos credenciales de acceso a zona restringida'), LOG_WARNING, ['file' => $e->getFile() . '[' . $e->getLine() . ']']); |
|
| 143 | 1 | return Admin::staticAdminLogon(); |
|
| 144 | 3 | } catch (RouterException $r) { |
|
| 145 | 3 | Logger::log($r->getMessage(), LOG_WARNING); |
|
| 146 | 3 | $code = $r->getCode(); |
|
| 147 | } catch (Exception $e) { |
||
| 148 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 149 | throw $e; |
||
| 150 | } |
||
| 151 | |||
| 152 | 3 | throw new RouterException(t('Página no encontrada'), $code); |
|
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * @param string $route |
||
| 157 | * @return mixed |
||
| 158 | * @throws AccessDeniedException |
||
| 159 | * @throws AdminCredentialsException |
||
| 160 | * @throws RouterException |
||
| 161 | * @throws Exception |
||
| 162 | */ |
||
| 163 | 5 | protected function searchAction($route) |
|
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * @param array $action |
||
| 196 | * @param array $params |
||
| 197 | * @return bool |
||
| 198 | */ |
||
| 199 | 3 | private function checkRequirements(array $action, $params = []) |
|
| 214 | } |
||
| 215 | |||
| 216 | /** |
||
| 217 | * @throws ConfigException |
||
| 218 | * @throws InvalidArgumentException |
||
| 219 | * @throws ReflectionException |
||
| 220 | * @throws GeneratorException |
||
| 221 | */ |
||
| 222 | 3 | private function generateRouting() |
|
| 223 | { |
||
| 224 | 3 | $base = SOURCE_DIR; |
|
| 225 | 3 | $modulesPath = realpath(CORE_DIR); |
|
| 226 | 3 | $this->routing = $this->inspectDir($base, 'PSFS', array()); |
|
| 227 | 3 | $this->checkExternalModules(); |
|
| 228 | 3 | if (file_exists($modulesPath)) { |
|
| 229 | 1 | $modules = $this->finder->directories()->in($modulesPath)->depth(0); |
|
| 230 | 1 | if ($modules->hasResults()) { |
|
| 231 | 1 | foreach ($modules->getIterator() as $modulePath) { |
|
| 232 | 1 | $module = $modulePath->getBasename(); |
|
| 233 | 1 | $this->routing = $this->inspectDir($modulesPath . DIRECTORY_SEPARATOR . $module, $module, $this->routing); |
|
| 234 | } |
||
| 235 | } |
||
| 236 | } |
||
| 237 | 3 | $this->cache->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json', $this->domains, Cache::JSON, TRUE); |
|
| 238 | 3 | } |
|
| 239 | |||
| 240 | /** |
||
| 241 | * @throws GeneratorException |
||
| 242 | * @throws ConfigException |
||
| 243 | * @throws InvalidArgumentException |
||
| 244 | * @throws ReflectionException |
||
| 245 | */ |
||
| 246 | 3 | public function hydrateRouting() |
|
| 247 | { |
||
| 248 | 3 | $this->generateRouting(); |
|
| 249 | 3 | $home = Config::getParam('home.action', 'admin'); |
|
| 250 | 3 | if (NULL !== $home || $home !== '') { |
|
| 251 | 3 | $homeParams = NULL; |
|
| 252 | 3 | foreach ($this->routing as $pattern => $params) { |
|
| 253 | 3 | list($method, $route) = RouterHelper::extractHttpRoute($pattern); |
|
| 254 | 3 | if (preg_match('/' . preg_quote($route, '/') . '$/i', '/' . $home)) { |
|
| 255 | 3 | $homeParams = $params; |
|
| 256 | } |
||
| 257 | 3 | unset($method); |
|
| 258 | } |
||
| 259 | 3 | if (NULL !== $homeParams) { |
|
| 260 | 3 | $this->routing['/'] = $homeParams; |
|
| 261 | } |
||
| 262 | } |
||
| 263 | 3 | } |
|
| 264 | |||
| 265 | /** |
||
| 266 | * @param string $namespace |
||
| 267 | * @return bool |
||
| 268 | */ |
||
| 269 | 5 | public static function exists($namespace) |
|
| 270 | { |
||
| 271 | 5 | return (class_exists($namespace) || interface_exists($namespace) || trait_exists($namespace)); |
|
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * @return $this |
||
| 276 | * @throws GeneratorException |
||
| 277 | */ |
||
| 278 | 3 | public function simpatize() |
|
| 279 | { |
||
| 280 | 3 | $this->generateSlugs(); |
|
| 281 | 3 | GeneratorHelper::createDir(CONFIG_DIR); |
|
| 282 | 3 | Cache::getInstance()->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . 'urls.json', array($this->routing, $this->slugs), Cache::JSON, TRUE); |
|
| 283 | |||
| 284 | 3 | return $this; |
|
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * @param string $slug |
||
| 289 | * @param boolean $absolute |
||
| 290 | * @param array $params |
||
| 291 | * |
||
| 292 | * @return string|null |
||
| 293 | * @throws RouterException |
||
| 294 | */ |
||
| 295 | 3 | public function getRoute($slug = '', $absolute = false, array $params = []) |
|
| 296 | { |
||
| 297 | 3 | $baseUrl = $absolute ? Request::getInstance()->getRootUrl() : ''; |
|
| 298 | 3 | if ('' === $slug) { |
|
| 299 | 1 | return $baseUrl . '/'; |
|
| 300 | } |
||
| 301 | 3 | if (!is_array($this->slugs) || !array_key_exists($slug, $this->slugs)) { |
|
| 302 | 1 | throw new RouterException(t('No existe la ruta especificada')); |
|
| 303 | } |
||
| 304 | 3 | $url = $baseUrl . $this->slugs[$slug]; |
|
| 305 | 3 | if (!empty($params)) { |
|
| 306 | foreach ($params as $key => $value) { |
||
| 307 | $url = str_replace('{' . $key . '}', $value, $url); |
||
| 308 | } |
||
| 309 | 3 | } elseif (!empty($this->routing[$this->slugs[$slug]]['default'])) { |
|
| 310 | 3 | $url = $baseUrl . $this->routing[$this->slugs[$slug]]['default']; |
|
| 311 | } |
||
| 312 | |||
| 313 | 3 | return preg_replace('/(GET|POST|PUT|DELETE|ALL|HEAD|PATCH)\#\|\#/', '', $url); |
|
| 314 | } |
||
| 315 | |||
| 316 | /** |
||
| 317 | * @param string $class |
||
| 318 | * @param string $method |
||
| 319 | */ |
||
| 320 | 2 | private function checkPreActions($class, $method) |
|
| 321 | { |
||
| 322 | 2 | $preAction = 'pre' . ucfirst($method); |
|
| 323 | 2 | if (method_exists($class, $preAction)) { |
|
| 324 | Inspector::stats('[Router] Pre action invoked', Inspector::SCOPE_DEBUG); |
||
| 325 | try { |
||
| 326 | if (false === call_user_func_array([$class, $preAction])) { |
||
| 327 | Logger::log(t('Pre action failed'), LOG_ERR, [error_get_last()]); |
||
| 328 | error_clear_last(); |
||
| 329 | } |
||
| 330 | } catch (Exception $e) { |
||
| 331 | Logger::log($e->getMessage(), LOG_ERR, [$class, $method]); |
||
| 332 | } |
||
| 333 | } |
||
| 334 | 2 | } |
|
| 335 | |||
| 336 | /** |
||
| 337 | * @param string $route |
||
| 338 | * @param array $action |
||
| 339 | * @param string $class |
||
| 340 | * @param array $params |
||
| 341 | * @return mixed |
||
| 342 | * @throws GeneratorException |
||
| 343 | * @throws ConfigException |
||
| 344 | */ |
||
| 345 | 2 | protected function executeCachedRoute($route, $action, $class, $params = NULL) |
|
| 346 | { |
||
| 347 | 2 | Inspector::stats('[Router] Executing route ' . $route, Inspector::SCOPE_DEBUG); |
|
| 348 | 2 | $action['params'] = array_merge($action['params'], $params, Request::getInstance()->getQueryParams()); |
|
| 349 | 2 | Security::getInstance()->setSessionKey(Cache::CACHE_SESSION_VAR, $action); |
|
| 350 | 2 | $cache = Cache::needCache(); |
|
| 351 | 2 | $execute = TRUE; |
|
| 352 | 2 | $return = null; |
|
| 353 | 2 | if (FALSE !== $cache && $action['http'] === 'GET' && Config::getParam('debug') === FALSE) { |
|
| 354 | list($path, $cacheDataName) = $this->cache->getRequestCacheHash(); |
||
| 355 | $cachedData = $this->cache->readFromCache('json' . DIRECTORY_SEPARATOR . $path . $cacheDataName, $cache); |
||
| 356 | if (NULL !== $cachedData) { |
||
| 357 | $headers = $this->cache->readFromCache('json' . DIRECTORY_SEPARATOR . $path . $cacheDataName . '.headers', $cache, null, Cache::JSON); |
||
| 358 | Template::getInstance()->renderCache($cachedData, $headers); |
||
| 359 | $execute = FALSE; |
||
| 360 | } |
||
| 361 | } |
||
| 362 | 2 | if ($execute) { |
|
| 363 | 2 | Inspector::stats('[Router] Start executing action ' . $route, Inspector::SCOPE_DEBUG); |
|
| 364 | 2 | $this->checkPreActions($class, $action['method']); |
|
| 365 | 2 | $return = call_user_func_array([$class, $action['method']], $params); |
|
| 366 | 1 | if (false === $return) { |
|
| 367 | Logger::log(t('An error occurred trying to execute the action'), LOG_ERR, [error_get_last()]); |
||
| 368 | } |
||
| 369 | } |
||
| 370 | 1 | return $return; |
|
| 371 | } |
||
| 372 | |||
| 373 | /** |
||
| 374 | * Parse slugs to create translations |
||
| 375 | */ |
||
| 376 | 3 | private function generateSlugs() |
|
| 377 | { |
||
| 378 | 3 | foreach ($this->routing as $key => &$info) { |
|
| 379 | 3 | $keyParts = explode('#|#', $key); |
|
| 380 | 3 | $keyParts = array_key_exists(1, $keyParts) ? $keyParts[1] : $keyParts[0]; |
|
| 381 | 3 | $slug = RouterHelper::slugify($keyParts); |
|
| 382 | 3 | $this->slugs[$slug] = $key; |
|
| 383 | 3 | $info['slug'] = $slug; |
|
| 384 | // TODO add routes to translations JSON |
||
| 385 | } |
||
| 386 | 3 | } |
|
| 387 | |||
| 388 | /** |
||
| 389 | * @param Exception|null $exception |
||
| 390 | * @param bool $isJson |
||
| 391 | * @return string |
||
| 392 | * @throws GeneratorException |
||
| 393 | */ |
||
| 394 | public function httpNotFound(\Exception $exception = null, $isJson = false) |
||
| 397 | } |
||
| 398 | } |
||
| 399 |
Loading history...
