jetfirephp /
routing
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like RouteCollection 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 RouteCollection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class RouteCollection |
||
| 11 | { |
||
| 12 | |||
| 13 | /** |
||
| 14 | * @var array |
||
| 15 | */ |
||
| 16 | private $routes = []; |
||
| 17 | /** |
||
| 18 | * @var array |
||
| 19 | */ |
||
| 20 | public $routesByName = []; |
||
| 21 | /** |
||
| 22 | * @var int |
||
| 23 | */ |
||
| 24 | public $countRoutes = 0; |
||
| 25 | /** |
||
| 26 | * @var |
||
| 27 | */ |
||
| 28 | public $matcher; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @param array $routes |
||
| 32 | * @param array $options |
||
| 33 | */ |
||
| 34 | public function __construct($routes = null, $options = []) |
||
| 35 | { |
||
| 36 | if (!is_null($routes) || !empty($options)) $this->addRoutes($routes, $options); |
||
| 37 | } |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @param array|string $routes |
||
| 41 | * @param array $options |
||
| 42 | */ |
||
| 43 | public function addRoutes($routes = null, $options = []) |
||
| 44 | { |
||
| 45 | if (!is_null($routes) && !is_array($routes)) { |
||
| 46 | if (strpos($routes, '.php') === false) $routes = trim($routes, '/') . '/'; |
||
| 47 | if (is_file($routes . '/routes.php') && is_array($routesFile = include $routes . '/routes.php')) $routes = $routesFile; |
||
| 48 | elseif (is_file($routes) && is_array($routesFile = include $routes)) $routes = $routesFile; |
||
| 49 | else throw new \InvalidArgumentException('Argument for "' . get_called_class() . '" constructor is not recognized. Expected argument array or file containing array but "' . $routes . '" given'); |
||
| 50 | } |
||
| 51 | $this->routes['routes_' . $this->countRoutes] = is_array($routes) ? $routes : []; |
||
| 52 | $this->setRoutes($options, $this->countRoutes); |
||
| 53 | $this->countRoutes++; |
||
| 54 | } |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @param null $key |
||
| 58 | * @return array |
||
| 59 | */ |
||
| 60 | public function getRoutes($key = null) |
||
| 61 | { |
||
| 62 | if (!is_null($key)) |
||
| 63 | return isset($this->routes[$key]) ? $this->routes[$key] : ''; |
||
| 64 | return $this->routes; |
||
| 65 | } |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @param $args |
||
| 69 | */ |
||
| 70 | public function setPrefix($args) |
||
| 71 | { |
||
| 72 | if (is_array($args)) { |
||
| 73 | $nbrArgs = count($args); |
||
| 74 | View Code Duplication | for ($i = 0; $i < $nbrArgs; ++$i) |
|
|
|
|||
| 75 | $this->routes['prefix_' . $i] = '/' . trim($args[$i], '/'); |
||
| 76 | } elseif (is_string($args)) |
||
| 77 | View Code Duplication | for ($i = 0; $i < $this->countRoutes; ++$i) |
|
| 78 | $this->routes['prefix_' . $i] = '/' . trim($args, '/'); |
||
| 79 | if ($this->countRoutes == 0) $this->countRoutes++; |
||
| 80 | } |
||
| 81 | |||
| 82 | /** |
||
| 83 | * @param $args |
||
| 84 | */ |
||
| 85 | public function setOption($args = []) |
||
| 86 | { |
||
| 87 | $nbrArgs = count($args); |
||
| 88 | for ($i = 0; $i < $nbrArgs; ++$i) { |
||
| 89 | if (is_array($args[$i])) { |
||
| 90 | $this->setRoutes($args[$i], $i); |
||
| 91 | if (!isset($this->routes['routes_' . $i])) $this->routes['routes_' . $i] = []; |
||
| 92 | } |
||
| 93 | } |
||
| 94 | if ($this->countRoutes == 0) $this->countRoutes++; |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * @param array $args |
||
| 99 | * @param $i |
||
| 100 | */ |
||
| 101 | private function setRoutes($args = [], $i) |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @param string $root |
||
| 112 | * @param string $script_file |
||
| 113 | * @return bool |
||
| 114 | */ |
||
| 115 | public function generateRoutesPath($root = null, $script_file = 'index.php') |
||
| 154 | |||
| 155 | /** |
||
| 156 | * @param $url |
||
| 157 | * @return string |
||
| 158 | */ |
||
| 159 | public function getDomain($url) |
||
| 168 | |||
| 169 | /** |
||
| 170 | * @param null $name |
||
| 171 | * @param array $params |
||
| 172 | * @param string $subdomain |
||
| 173 | * @return mixed |
||
| 174 | */ |
||
| 175 | public function getRoutePath($name, $params = [], $subdomain = '') |
||
| 186 | } |
||
| 187 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.