psfs /
core
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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 |
||
| 24 | class Router |
||
| 25 | { |
||
| 26 | |||
| 27 | use SingletonTrait; |
||
| 28 | |||
| 29 | protected $routing; |
||
| 30 | protected $slugs; |
||
| 31 | private $domains; |
||
| 32 | /** |
||
| 33 | * @var Finder $finder |
||
| 34 | */ |
||
| 35 | private $finder; |
||
| 36 | /** |
||
| 37 | * @var \PSFS\base\Cache $cache |
||
| 38 | */ |
||
| 39 | private $cache; |
||
| 40 | /** |
||
| 41 | * @var bool headersSent |
||
| 42 | */ |
||
| 43 | protected $headersSent = false; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Constructor Router |
||
| 47 | * @throws ConfigException |
||
| 48 | */ |
||
| 49 | 6 | public function __construct() |
|
| 50 | { |
||
| 51 | 6 | $this->finder = new Finder(); |
|
| 52 | 6 | $this->cache = Cache::getInstance(); |
|
| 53 | 6 | $this->init(); |
|
| 54 | 6 | } |
|
| 55 | |||
| 56 | /** |
||
| 57 | * Inicializador Router |
||
| 58 | * @throws ConfigException |
||
| 59 | */ |
||
| 60 | 1 | public function init() |
|
| 70 | |||
| 71 | /** |
||
| 72 | * Método que deriva un error HTTP de página no encontrada |
||
| 73 | * |
||
| 74 | * @param \Exception $e |
||
| 75 | * |
||
| 76 | * @return string HTML |
||
| 77 | */ |
||
| 78 | public function httpNotFound(\Exception $e = NULL) |
||
| 79 | { |
||
| 80 | Logger::log('Throw not found exception'); |
||
| 81 | if (NULL === $e) { |
||
| 82 | Logger::log('Not found page throwed without previous exception', LOG_WARNING); |
||
| 83 | $e = new \Exception(_('Page not found'), 404); |
||
| 84 | } |
||
| 85 | $template = Template::getInstance()->setStatus($e->getCode()); |
||
| 86 | if (preg_match('/json/i', Request::getInstance()->getServer('CONTENT_TYPE'))) { |
||
| 87 | return $template->output(json_encode(array( |
||
| 88 | "success" => FALSE, |
||
| 89 | "error" => $e->getMessage(), |
||
| 90 | )), 'application/json'); |
||
| 91 | } else { |
||
| 92 | return $template->render('error.html.twig', array( |
||
| 93 | 'exception' => $e, |
||
| 94 | 'trace' => $e->getTraceAsString(), |
||
| 95 | 'error_page' => TRUE, |
||
| 96 | )); |
||
| 97 | } |
||
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Método que devuelve las rutas |
||
| 102 | * @return string|null |
||
| 103 | */ |
||
| 104 | public function getSlugs() |
||
| 105 | { |
||
| 106 | return $this->slugs; |
||
| 107 | } |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Method that extract all routes in the platform |
||
| 111 | * @return array |
||
| 112 | */ |
||
| 113 | public function getAllRoutes() { |
||
| 114 | $routes = []; |
||
| 115 | foreach($this->routing as $path => $route) { |
||
| 116 | if(array_key_exists('slug', $route)) { |
||
| 117 | $routes[$route['slug']] = $path; |
||
| 118 | } |
||
| 119 | } |
||
| 120 | return $routes; |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Método que calcula el objeto a enrutar |
||
| 125 | * |
||
| 126 | * @param string|null $route |
||
| 127 | * |
||
| 128 | * @throws \Exception |
||
| 129 | * @return string HTML |
||
| 130 | */ |
||
| 131 | public function execute($route) |
||
| 132 | { |
||
| 133 | Logger::log('Executing the request'); |
||
| 134 | try { |
||
| 135 | //Check CORS for requests |
||
| 136 | RequestHelper::checkCORS(); |
||
| 137 | // Checks restricted access |
||
| 138 | SecurityHelper::checkRestrictedAccess($route); |
||
| 139 | //Search action and execute |
||
| 140 | $this->searchAction($route); |
||
| 141 | } catch (AccessDeniedException $e) { |
||
| 142 | Logger::log(_('Solicitamos credenciales de acceso a zona restringida')); |
||
| 143 | return Admin::staticAdminLogon($route); |
||
| 144 | } catch (RouterException $r) { |
||
| 145 | Logger::log($r->getMessage(), LOG_WARNING); |
||
| 146 | } catch (\Exception $e) { |
||
| 147 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 148 | throw $e; |
||
| 149 | } |
||
| 150 | |||
| 151 | return $this->httpNotFound(); |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Método que busca el componente que ejecuta la ruta |
||
| 156 | * |
||
| 157 | * @param string $route |
||
| 158 | * |
||
| 159 | * @throws \PSFS\base\exception\RouterException |
||
| 160 | */ |
||
| 161 | protected function searchAction($route) |
||
| 162 | { |
||
| 163 | Logger::log('Searching action to execute: ' . $route, LOG_INFO); |
||
| 164 | //Revisamos si tenemos la ruta registrada |
||
| 165 | $parts = parse_url($route); |
||
| 166 | $path = (array_key_exists('path', $parts)) ? $parts['path'] : $route; |
||
| 167 | $httpRequest = Request::getInstance()->getMethod(); |
||
| 168 | foreach ($this->routing as $pattern => $action) { |
||
| 169 | list($httpMethod, $routePattern) = RouterHelper::extractHttpRoute($pattern); |
||
| 170 | $matched = RouterHelper::matchRoutePattern($routePattern, $path); |
||
| 171 | if ($matched && ($httpMethod === "ALL" || $httpRequest === $httpMethod) && RouterHelper::compareSlashes($routePattern, $path)) { |
||
| 172 | $get = RouterHelper::extractComponents($route, $routePattern); |
||
| 173 | /** @var $class \PSFS\base\types\Controller */ |
||
| 174 | $class = RouterHelper::getClassToCall($action); |
||
| 175 | try { |
||
| 176 | $this->executeCachedRoute($route, $action, $class, $get); |
||
| 177 | } catch (\Exception $e) { |
||
| 178 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 179 | throw new RouterException($e->getMessage(), 404, $e); |
||
| 180 | } |
||
| 181 | } |
||
| 182 | } |
||
| 183 | throw new RouterException(_("Ruta no encontrada")); |
||
| 184 | } |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Método que manda las cabeceras de autenticación |
||
| 188 | * @return string HTML |
||
| 189 | */ |
||
| 190 | protected function sentAuthHeader() |
||
| 191 | { |
||
| 192 | return AdminServices::getInstance()->setAdminHeaders(); |
||
| 193 | } |
||
| 194 | |||
| 195 | /** |
||
| 196 | * Method that gather all the routes in the project |
||
| 197 | */ |
||
| 198 | 1 | private function generateRouting() |
|
| 199 | { |
||
| 200 | 1 | $base = SOURCE_DIR; |
|
| 201 | 1 | $modulesPath = realpath(CORE_DIR); |
|
| 202 | 1 | $this->routing = $this->inspectDir($base, "PSFS", array()); |
|
| 203 | 1 | if (file_exists($modulesPath)) { |
|
| 204 | $module = ""; |
||
| 205 | if(file_exists($modulesPath . DIRECTORY_SEPARATOR . 'module.json')) { |
||
| 206 | $mod_cfg = json_decode(file_get_contents($modulesPath . DIRECTORY_SEPARATOR . 'module.json'), true); |
||
| 207 | $module = $mod_cfg['module']; |
||
| 208 | } |
||
| 209 | $modules = $this->finder->directories()->in($modulesPath)->depth(0); |
||
| 210 | foreach($modules as $modulePath) { |
||
| 211 | $module = $modulePath->getBasename(); |
||
| 212 | $this->routing = $this->inspectDir($modulesPath . DIRECTORY_SEPARATOR . $module, $module, $this->routing); |
||
| 213 | } |
||
| 214 | } |
||
| 215 | 1 | $this->cache->storeData(CONFIG_DIR . DIRECTORY_SEPARATOR . "domains.json", $this->domains, Cache::JSON, TRUE); |
|
| 216 | 1 | } |
|
| 217 | |||
| 218 | /** |
||
| 219 | * Método que regenera el fichero de rutas |
||
| 220 | * @throws ConfigException |
||
| 221 | */ |
||
| 222 | 1 | public function hydrateRouting() |
|
| 239 | |||
| 240 | /** |
||
| 241 | * Método que inspecciona los directorios en busca de clases que registren rutas |
||
| 242 | * |
||
| 243 | * @param string $origen |
||
| 244 | * @param string $namespace |
||
| 245 | * @param array $routing |
||
| 246 | * |
||
| 247 | * @return array |
||
| 248 | * @throws ConfigException |
||
| 249 | */ |
||
| 250 | 1 | private function inspectDir($origen, $namespace = 'PSFS', $routing = []) |
|
| 261 | |||
| 262 | /** |
||
| 263 | * Checks that a namespace exists |
||
| 264 | * @param string $namespace |
||
| 265 | * @return bool |
||
| 266 | */ |
||
| 267 | 1 | public static function exists($namespace) { |
|
| 270 | |||
| 271 | /** |
||
| 272 | * Método que añade nuevas rutas al array de referencia |
||
| 273 | * |
||
| 274 | * @param string $namespace |
||
| 275 | * @param array $routing |
||
| 276 | * @param string $module |
||
| 277 | * |
||
| 278 | * @return array |
||
| 279 | * @throws ConfigException |
||
| 280 | */ |
||
| 281 | 1 | private function addRouting($namespace, &$routing, $module = 'PSFS') |
|
| 305 | |||
| 306 | /** |
||
| 307 | * Método que extrae de la ReflectionClass los datos necesarios para componer los dominios en los templates |
||
| 308 | * |
||
| 309 | * @param \ReflectionClass $class |
||
| 310 | * |
||
| 311 | * @return Router |
||
| 312 | * @throws ConfigException |
||
| 313 | */ |
||
| 314 | 1 | protected function extractDomain(\ReflectionClass $class) |
|
| 329 | |||
| 330 | /** |
||
| 331 | * Método que genera las urls amigables para usar dentro del framework |
||
| 332 | * @return Router |
||
| 333 | */ |
||
| 334 | 1 | public function simpatize() |
|
| 344 | |||
| 345 | /** |
||
| 346 | * Método que devuelve una ruta del framework |
||
| 347 | * |
||
| 348 | * @param string $slug |
||
| 349 | * @param boolean $absolute |
||
| 350 | * @param array $params |
||
| 351 | * |
||
| 352 | * @return string|null |
||
| 353 | * @throws RouterException |
||
| 354 | */ |
||
| 355 | 1 | public function getRoute($slug = '', $absolute = FALSE, $params = []) |
|
| 372 | |||
| 373 | /** |
||
| 374 | * Método que devuelve las rutas de administración |
||
| 375 | * @return array |
||
| 376 | */ |
||
| 377 | 1 | public function getAdminRoutes() |
|
| 381 | |||
| 382 | /** |
||
| 383 | * Método que devuelve le controlador del admin |
||
| 384 | * @return Admin |
||
| 385 | */ |
||
| 386 | public function getAdmin() |
||
| 390 | |||
| 391 | /** |
||
| 392 | * Método que extrae los dominios |
||
| 393 | * @return array |
||
| 394 | */ |
||
| 395 | public function getDomains() |
||
| 399 | |||
| 400 | /** |
||
| 401 | * Método que ejecuta una acción del framework y revisa si lo tenemos cacheado ya o no |
||
| 402 | * |
||
| 403 | * @param string $route |
||
| 404 | * @param array|null $action |
||
| 405 | * @param types\Controller $class |
||
| 406 | * @param array $params |
||
| 407 | */ |
||
| 408 | protected function executeCachedRoute($route, $action, $class, $params = NULL) |
||
| 433 | |||
| 434 | /** |
||
| 435 | * Parse slugs to create translations |
||
| 436 | * |
||
| 437 | * @param string $absoluteTranslationFileName |
||
| 438 | */ |
||
| 439 | 1 | private function generateSlugs($absoluteTranslationFileName) |
|
| 457 | |||
| 458 | } |
||
| 459 |
Loading history...
Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.