acacha /
adminlte-laravel
Complex classes like AdminLTERoute 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 AdminLTERoute, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | class AdminLTERoute extends Command |
||
| 23 | { |
||
| 24 | use HasUsername, HasEmail, Controller; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Path to web routes file. |
||
| 28 | * |
||
| 29 | * @var string |
||
| 30 | */ |
||
| 31 | protected $web_routes_path = 'routes/web.php'; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Path to api routes file. |
||
| 35 | * |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | protected $api_routes_path = 'routes/api.php'; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Compiler for stub file. |
||
| 42 | * |
||
| 43 | * @var StubFileCompiler |
||
| 44 | */ |
||
| 45 | protected $compiler; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Compiler for stub file. |
||
| 49 | * |
||
| 50 | * @var Filesystem |
||
| 51 | */ |
||
| 52 | protected $filesystem; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @var array |
||
| 56 | */ |
||
| 57 | protected static $lookup = [ |
||
| 58 | 'regular' => RegularRoute::class, |
||
| 59 | 'controller' => ControllerRoute::class, |
||
| 60 | 'resource' => ControllerResourceRoute::class, |
||
| 61 | ]; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * The name and signature of the console command. |
||
| 65 | */ |
||
| 66 | protected $signature = 'adminlte-laravel:route {link: The route link} {action? : View or controller to create} {--t|type=regular : Type of route to create (regular,controller,resource)} {--m|method=get : HTTP method} {--api : Route is an api route} {--a|createaction : Create view or controller after route}'; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * The console command description. |
||
| 70 | * |
||
| 71 | * @var string |
||
| 72 | */ |
||
| 73 | protected $description = 'Insert a route to routes/web.php file'; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * AdminLTERoute constructor. |
||
| 77 | * |
||
| 78 | * @param StubFileCompiler $compiler |
||
| 79 | * @param Filesystem $filesystem |
||
| 80 | */ |
||
| 81 | public function __construct(StubFileCompiler $compiler, Filesystem $filesystem) |
||
| 87 | |||
| 88 | /** |
||
| 89 | * Execute the console command. |
||
| 90 | */ |
||
| 91 | public function handle() |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Get mountpoint. |
||
| 104 | * |
||
| 105 | * @return string |
||
| 106 | */ |
||
| 107 | protected function mountpoint() |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Destination route file. |
||
| 115 | * |
||
| 116 | * @return string |
||
| 117 | */ |
||
| 118 | protected function destinationFile() { |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Warn if route already exists. |
||
| 125 | * |
||
| 126 | * @param $link |
||
| 127 | */ |
||
| 128 | protected function warnIfRouteAlreadyExists($link) |
||
| 137 | |||
| 138 | /** |
||
| 139 | * Check if route exists. |
||
| 140 | * |
||
| 141 | * @param $link |
||
| 142 | * @return mixed |
||
| 143 | */ |
||
| 144 | protected function routeExists($link) |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Check if web route exists. |
||
| 152 | * |
||
| 153 | * @param $link |
||
| 154 | * @return mixed |
||
| 155 | */ |
||
| 156 | protected function webRouteExists($link) |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Remove (if exists) trailing slash from link. |
||
| 170 | * |
||
| 171 | * @param $link |
||
| 172 | * @return string |
||
| 173 | */ |
||
| 174 | protected function removeTrailingSlashIfExists($link){ |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Remove duplicated trailing slashes. |
||
| 181 | * |
||
| 182 | * @param $link |
||
| 183 | * @return mixed |
||
| 184 | */ |
||
| 185 | protected function removeDuplicatedTrailingSlashes($link) |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Check if api route exists. |
||
| 192 | * |
||
| 193 | * @param $link |
||
| 194 | * @return mixed |
||
| 195 | */ |
||
| 196 | protected function apiRouteExists($link) |
||
| 200 | |||
| 201 | /** |
||
| 202 | * Crete tmp file with route to add. |
||
| 203 | * |
||
| 204 | * @return mixed |
||
| 205 | */ |
||
| 206 | protected function createTmpFileWithRoute() |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Get path from file resource. |
||
| 215 | * |
||
| 216 | * @param $tmpfile |
||
| 217 | * @return mixed |
||
| 218 | */ |
||
| 219 | protected function getPath($tmpfile) |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Get route code to insert depending on type. |
||
| 226 | * |
||
| 227 | * @return mixed |
||
| 228 | */ |
||
| 229 | protected function getRouteCode() |
||
| 244 | |||
| 245 | /** |
||
| 246 | * Get method. |
||
| 247 | * |
||
| 248 | * @return string |
||
| 249 | */ |
||
| 250 | protected function method() |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Get the action replacement. |
||
| 258 | * |
||
| 259 | * @return array|string |
||
| 260 | */ |
||
| 261 | protected function action() |
||
| 268 | |||
| 269 | /** |
||
| 270 | * Process input. |
||
| 271 | */ |
||
| 272 | protected function processInput() |
||
| 277 | |||
| 278 | /** |
||
| 279 | * Validate option method. |
||
| 280 | */ |
||
| 281 | protected function validateMethod() |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Validate option type. |
||
| 290 | */ |
||
| 291 | protected function validateType() |
||
| 297 | |||
| 298 | /** |
||
| 299 | * Execute post actions (if exists) |
||
| 300 | */ |
||
| 301 | protected function postActions() |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Create action (view|controller). |
||
| 309 | */ |
||
| 310 | protected function createAction() |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Create View. |
||
| 319 | */ |
||
| 320 | protected function createView() |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Create regular controller. |
||
| 330 | */ |
||
| 331 | protected function createController() |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Create resource controller. |
||
| 342 | */ |
||
| 343 | protected function createResourceController() |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Add method to controller. |
||
| 354 | * |
||
| 355 | * @param $controller |
||
| 356 | * @param $controllerMethod * |
||
| 357 | */ |
||
| 358 | protected function addMethodToController($controller, $controllerMethod) |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Crete tmp file with route to add. |
||
| 367 | * |
||
| 368 | * @param $controllerMethod |
||
| 369 | * @return mixed |
||
| 370 | */ |
||
| 371 | protected function createTmpFileWithMethod($controllerMethod) |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Get method code. |
||
| 380 | * |
||
| 381 | * @param $controllerMethod |
||
| 382 | * @return mixed |
||
| 383 | */ |
||
| 384 | protected function getMethodCode($controllerMethod) |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Get method stub path. |
||
| 396 | * |
||
| 397 | * @return string |
||
| 398 | */ |
||
| 399 | protected function getMethodStubPath() |
||
| 403 | |||
| 404 | } |
||
| 405 |
An exit expression should only be used in rare cases. For example, if you write a short command line script.
In most cases however, using an
exitexpression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.