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) |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Método que devuelve las rutas |
||
| 103 | * @return string|null |
||
| 104 | */ |
||
| 105 | public function getSlugs() |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Method that extract all routes in the platform |
||
| 112 | * @return array |
||
| 113 | */ |
||
| 114 | public function getAllRoutes() { |
||
| 115 | $routes = []; |
||
| 116 | foreach($this->routing as $path => $route) { |
||
| 117 | if(array_key_exists('slug', $route)) { |
||
| 118 | $routes[$route['slug']] = $path; |
||
| 119 | } |
||
| 120 | } |
||
| 121 | return $routes; |
||
| 122 | } |
||
| 123 | |||
| 124 | /** |
||
| 125 | * Método que calcula el objeto a enrutar |
||
| 126 | * |
||
| 127 | * @param string|null $route |
||
| 128 | * |
||
| 129 | * @throws \Exception |
||
| 130 | * @return string HTML |
||
| 131 | */ |
||
| 132 | public function execute($route) |
||
| 133 | { |
||
| 134 | Logger::log('Executing the request'); |
||
| 135 | try { |
||
| 136 | //Check CORS for requests |
||
| 137 | RequestHelper::checkCORS(); |
||
| 138 | // Checks restricted access |
||
| 139 | SecurityHelper::checkRestrictedAccess($route); |
||
| 140 | //Search action and execute |
||
| 141 | $this->searchAction($route); |
||
| 142 | } catch (AccessDeniedException $e) { |
||
| 143 | Logger::log(_('Solicitamos credenciales de acceso a zona restringida')); |
||
| 144 | return Admin::staticAdminLogon($route); |
||
| 145 | } catch (RouterException $r) { |
||
| 146 | if(null === RouterHelper::checkDefaultRoute($route)) { |
||
| 147 | Logger::log($r->getMessage(), LOG_WARNING); |
||
| 148 | throw $r; |
||
| 149 | } |
||
| 150 | } catch (\Exception $e) { |
||
| 151 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 152 | throw $e; |
||
| 153 | } |
||
| 154 | |||
| 155 | return $this->httpNotFound(); |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Método que busca el componente que ejecuta la ruta |
||
| 160 | * |
||
| 161 | * @param string $route |
||
| 162 | * |
||
| 163 | * @throws \PSFS\base\exception\RouterException |
||
| 164 | */ |
||
| 165 | protected function searchAction($route) |
||
| 166 | { |
||
| 167 | Logger::log('Searching action to execute: ' . $route, LOG_INFO); |
||
| 168 | //Revisamos si tenemos la ruta registrada |
||
| 169 | $parts = parse_url($route); |
||
| 170 | $path = (array_key_exists('path', $parts)) ? $parts['path'] : $route; |
||
| 171 | $httpRequest = Request::getInstance()->getMethod(); |
||
| 172 | foreach ($this->routing as $pattern => $action) { |
||
| 173 | list($httpMethod, $routePattern) = RouterHelper::extractHttpRoute($pattern); |
||
| 174 | $matched = RouterHelper::matchRoutePattern($routePattern, $path); |
||
| 175 | if ($matched && ($httpMethod === "ALL" || $httpRequest === $httpMethod) && RouterHelper::compareSlashes($routePattern, $path)) { |
||
| 176 | $get = RouterHelper::extractComponents($route, $routePattern); |
||
| 177 | /** @var $class \PSFS\base\types\Controller */ |
||
| 178 | $class = RouterHelper::getClassToCall($action); |
||
| 179 | try { |
||
| 180 | $this->executeCachedRoute($route, $action, $class, $get); |
||
| 181 | } catch (\Exception $e) { |
||
| 182 | Logger::log($e->getMessage(), LOG_ERR); |
||
| 183 | throw new RouterException($e->getMessage(), 404, $e); |
||
| 184 | } |
||
| 185 | } |
||
| 186 | } |
||
| 187 | throw new RouterException(_("Ruta no encontrada")); |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Método que manda las cabeceras de autenticación |
||
| 192 | * @return string HTML |
||
| 193 | */ |
||
| 194 | protected function sentAuthHeader() |
||
| 195 | { |
||
| 196 | return AdminServices::getInstance()->setAdminHeaders(); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Method that gather all the routes in the project |
||
| 201 | */ |
||
| 202 | 1 | private function generateRouting() |
|
| 203 | { |
||
| 204 | 1 | $base = SOURCE_DIR; |
|
| 205 | 1 | $modules = realpath(CORE_DIR); |
|
| 206 | 1 | $this->routing = $this->inspectDir($base, "PSFS", array()); |
|
| 207 | 1 | if (file_exists($modules)) { |
|
| 208 | $module = ""; |
||
| 209 | if(file_exists($modules . DIRECTORY_SEPARATOR . 'module.json')) { |
||
| 210 | $mod_cfg = json_decode(file_get_contents($modules . DIRECTORY_SEPARATOR . 'module.json'), true); |
||
| 211 | $module = $mod_cfg['module']; |
||
| 212 | } |
||
| 213 | $this->routing = $this->inspectDir($modules, $module, $this->routing); |
||
| 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() |
|
| 223 | { |
||
| 224 | 1 | $this->generateRouting(); |
|
| 225 | 1 | $home = Config::getInstance()->get('home_action'); |
|
| 226 | 1 | if (NULL !== $home || $home !== '') { |
|
| 227 | 1 | $home_params = NULL; |
|
| 228 | 1 | foreach ($this->routing as $pattern => $params) { |
|
| 229 | 1 | list($method, $route) = RouterHelper::extractHttpRoute($pattern); |
|
| 230 | 1 | if (preg_match("/" . preg_quote($route, "/") . "$/i", "/" . $home)) { |
|
| 231 | $home_params = $params; |
||
| 232 | } |
||
| 233 | 1 | } |
|
| 234 | 1 | if (NULL !== $home_params) { |
|
| 235 | $this->routing['/'] = $home_params; |
||
| 236 | } |
||
| 237 | 1 | } |
|
| 238 | 1 | } |
|
| 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) |
|
| 251 | { |
||
| 252 | 1 | $files = $this->finder->files()->in($origen)->path('/(controller|api)/i')->name("*.php"); |
|
| 253 | 1 | foreach ($files as $file) { |
|
| 254 | 1 | $filename = str_replace("/", '\\', str_replace($origen, '', $file->getPathname())); |
|
| 255 | 1 | $routing = $this->addRouting($namespace . str_replace('.php', '', $filename), $routing); |
|
| 256 | 1 | } |
|
| 257 | 1 | $this->finder = new Finder(); |
|
| 258 | |||
| 259 | 1 | return $routing; |
|
| 260 | } |
||
| 261 | |||
| 262 | /** |
||
| 263 | * Checks that a namespace exists |
||
| 264 | * @param string $namespace |
||
| 265 | * @return bool |
||
| 266 | */ |
||
| 267 | 1 | public static function exists($namespace) { |
|
| 268 | 1 | return (class_exists($namespace) || interface_exists($namespace) || trait_exists($namespace)); |
|
| 269 | } |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Método que añade nuevas rutas al array de referencia |
||
| 273 | * |
||
| 274 | * @param string $namespace |
||
| 275 | * @param array $routing |
||
| 276 | * |
||
| 277 | * @return array |
||
| 278 | * @throws ConfigException |
||
| 279 | */ |
||
| 280 | 1 | private function addRouting($namespace, &$routing) |
|
| 281 | { |
||
| 282 | 1 | if (self::exists($namespace)) { |
|
| 283 | 1 | $reflection = new \ReflectionClass($namespace); |
|
| 284 | 1 | if (FALSE === $reflection->isAbstract() && FALSE === $reflection->isInterface()) { |
|
| 285 | 1 | $this->extractDomain($reflection); |
|
| 286 | 1 | $classComments = $reflection->getDocComment(); |
|
| 287 | 1 | preg_match('/@api\ (.*)\n/im', $classComments, $apiPath); |
|
| 288 | 1 | $api = ''; |
|
| 289 | 1 | if (count($apiPath)) { |
|
| 290 | $api = array_key_exists(1, $apiPath) ? $apiPath[1] : $api; |
||
| 291 | } |
||
| 292 | 1 | foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) { |
|
| 293 | 1 | list($route, $info) = RouterHelper::extractRouteInfo($method, $api); |
|
| 294 | 1 | if(null !== $route && null !== $info) { |
|
| 295 | 1 | $info['class'] = $namespace; |
|
| 296 | 1 | $routing[$route] = $info; |
|
| 297 | 1 | } |
|
| 298 | 1 | } |
|
| 299 | 1 | } |
|
| 300 | 1 | } |
|
| 301 | |||
| 302 | 1 | return $routing; |
|
| 303 | } |
||
| 304 | |||
| 305 | /** |
||
| 306 | * Método que extrae de la ReflectionClass los datos necesarios para componer los dominios en los templates |
||
| 307 | * |
||
| 308 | * @param \ReflectionClass $class |
||
| 309 | * |
||
| 310 | * @return Router |
||
| 311 | * @throws ConfigException |
||
| 312 | */ |
||
| 313 | 1 | protected function extractDomain(\ReflectionClass $class) |
|
| 314 | { |
||
| 315 | //Calculamos los dominios para las plantillas |
||
| 316 | 1 | if ($class->hasConstant("DOMAIN") && !$class->isAbstract()) { |
|
| 317 | 1 | if(!$this->domains) { |
|
| 318 | 1 | $this->domains = []; |
|
| 319 | 1 | } |
|
| 320 | 1 | $domain = "@" . $class->getConstant("DOMAIN") . "/"; |
|
| 321 | 1 | if(!array_key_exists($domain, $this->domains)) { |
|
| 322 | 1 | $this->domains[$domain] = RouterHelper::extractDomainInfo($class, $domain); |
|
| 323 | 1 | } |
|
| 324 | 1 | } |
|
| 325 | |||
| 326 | 1 | return $this; |
|
| 327 | } |
||
| 328 | |||
| 329 | /** |
||
| 330 | * Método que genera las urls amigables para usar dentro del framework |
||
| 331 | * @return Router |
||
| 332 | */ |
||
| 333 | 1 | public function simpatize() |
|
| 343 | |||
| 344 | /** |
||
| 345 | * Método que devuelve una ruta del framework |
||
| 346 | * |
||
| 347 | * @param string $slug |
||
| 348 | * @param boolean $absolute |
||
| 349 | * @param array $params |
||
| 350 | * |
||
| 351 | * @return string|null |
||
| 352 | * @throws RouterException |
||
| 353 | */ |
||
| 354 | 1 | public function getRoute($slug = '', $absolute = FALSE, $params = []) |
|
| 371 | |||
| 372 | /** |
||
| 373 | * Método que devuelve las rutas de administración |
||
| 374 | * @return array |
||
| 375 | */ |
||
| 376 | 1 | public function getAdminRoutes() |
|
| 380 | |||
| 381 | /** |
||
| 382 | * Método que devuelve le controlador del admin |
||
| 383 | * @return Admin |
||
| 384 | */ |
||
| 385 | public function getAdmin() |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Método que extrae los dominios |
||
| 392 | * @return array |
||
| 393 | */ |
||
| 394 | public function getDomains() |
||
| 398 | |||
| 399 | /** |
||
| 400 | * Método que ejecuta una acción del framework y revisa si lo tenemos cacheado ya o no |
||
| 401 | * |
||
| 402 | * @param string $route |
||
| 403 | * @param array|null $action |
||
| 404 | * @param types\Controller $class |
||
| 405 | * @param array $params |
||
| 406 | */ |
||
| 407 | protected function executeCachedRoute($route, $action, $class, $params = NULL) |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Parse slugs to create translations |
||
| 431 | * |
||
| 432 | * @param string $absoluteTranslationFileName |
||
| 433 | */ |
||
| 434 | 1 | private function generateSlugs($absoluteTranslationFileName) |
|
| 452 | |||
| 453 | } |
||
| 454 |
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.