uccellolabs /
uccello
| Total Complexity | 50 |
| Total Lines | 355 |
| Duplicated Lines | 0 % |
| Changes | 4 | ||
| Bugs | 2 | Features | 0 |
Complex classes like MenuGenerator 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 MenuGenerator, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class MenuGenerator |
||
| 11 | { |
||
| 12 | /** |
||
| 13 | * Current domain |
||
| 14 | * |
||
| 15 | * @var \Uccello\Core\Models\Domain |
||
| 16 | */ |
||
| 17 | protected $domain; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Current module |
||
| 21 | * |
||
| 22 | * @var \Uccello\Core\Models\Module |
||
| 23 | */ |
||
| 24 | protected $module; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Main menu |
||
| 28 | * |
||
| 29 | * @var \Spatie\Menu\Laravel\Menu |
||
| 30 | */ |
||
| 31 | protected $menu; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * All names of modules added in the menu |
||
| 35 | * |
||
| 36 | * @var array |
||
| 37 | */ |
||
| 38 | protected $menuAddedModules; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Get menu generated |
||
| 42 | * |
||
| 43 | * @return \Spatie\Menu\Laravel\Menu |
||
| 44 | */ |
||
| 45 | public function getMenu() |
||
| 46 | { |
||
| 47 | return $this->menu; |
||
| 48 | } |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Make the menu according to the environment (main or admin) |
||
| 52 | * |
||
| 53 | * @param Domain $domain |
||
| 54 | * @param Module $module |
||
| 55 | * @return \Uccello\Core\Support\MenuGenerator |
||
| 56 | */ |
||
| 57 | public function makeMenu(Domain $domain, Module $module) |
||
| 58 | { |
||
| 59 | $this->domain = $domain; |
||
| 60 | |||
| 61 | $this->module = $module; |
||
| 62 | |||
| 63 | // Create menu |
||
| 64 | $this->menu = Menu::new() |
||
| 65 | ->withoutWrapperTag(); // Do not add <ul></ul> |
||
| 66 | |||
| 67 | // Add links to menu |
||
| 68 | $this->addLinksToMenu(); |
||
| 69 | |||
| 70 | return $this; |
||
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Add all links to the menu |
||
| 75 | * |
||
| 76 | * @return void |
||
| 77 | */ |
||
| 78 | protected function addLinksToMenu() |
||
| 79 | { |
||
| 80 | // Get the menu to display according to the environment (main or admin) |
||
| 81 | $domainMenu = $this->getDomainMenuToDisplay(); |
||
| 82 | |||
| 83 | $this->menuAddedModules = [ ]; |
||
| 84 | |||
| 85 | // If a menu was created, use it |
||
| 86 | if (!is_null($domainMenu)) { |
||
| 87 | $this->addLinksToMenuFromDomainMenu($domainMenu); |
||
| 88 | } |
||
| 89 | // Else add links from the modules list |
||
| 90 | else { |
||
| 91 | $this->addLinksToMenuFromModulesList(); |
||
| 92 | } |
||
| 93 | |||
| 94 | // If we are on a module not displayed in the menu, add it to the menu |
||
| 95 | $this->addActiveModuleIfNotInMenu(); |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * If a menu was created, use it and add its links in the menu |
||
| 100 | * |
||
| 101 | * @param \Uccello\Core\Models\Menu $domainMenu |
||
| 102 | * @return void |
||
| 103 | */ |
||
| 104 | protected function addLinksToMenuFromDomainMenu($domainMenu) |
||
| 105 | { |
||
| 106 | if (empty($domainMenu->data)) { |
||
| 107 | return; |
||
| 108 | } |
||
| 109 | |||
| 110 | foreach ($domainMenu->data as $menuLink) { |
||
| 111 | $this->addLink($this->menu, $menuLink); |
||
| 112 | } |
||
| 113 | |||
| 114 | // Add links added after the creation of the menu |
||
| 115 | $this->addLinksAddedAfterMenuCreation(); |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * If no menu was created we add all links available in the activated modules |
||
| 120 | * |
||
| 121 | * @return void |
||
| 122 | */ |
||
| 123 | protected function addLinksToMenuFromModulesList() |
||
| 124 | { |
||
| 125 | $modules = $this->getModulesVisibleInMenu(); |
||
| 126 | |||
| 127 | foreach ($modules as $module) { |
||
| 128 | foreach ($module->menuLinks as $menuLink) { |
||
| 129 | $menuLink->type = 'module'; |
||
| 130 | $menuLink->module = $module->name; |
||
| 131 | $this->addLink($this->menu, $menuLink); |
||
| 132 | } |
||
| 133 | } |
||
| 134 | } |
||
| 135 | |||
| 136 | /** |
||
| 137 | * If we are on a module not displayed in the menu, add it to the menu |
||
| 138 | * |
||
| 139 | * @return void |
||
| 140 | */ |
||
| 141 | protected function addActiveModuleIfNotInMenu() |
||
| 152 | } |
||
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Add to the menu, the links added after the creation of the menu |
||
| 157 | * (e.g. new modules or modules activated after the creation) |
||
| 158 | */ |
||
| 159 | protected function addLinksAddedAfterMenuCreation() |
||
| 169 | } |
||
| 170 | } |
||
| 171 | } |
||
| 172 | } |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Recursive function to add a link to the menu with all its children |
||
| 176 | * |
||
| 177 | * @param \Spatie\Menu\Laravel\Menu $menu |
||
| 178 | * @param \StdClass $menuLink |
||
| 179 | * @param boolean $isInSubMenu |
||
| 180 | * @param boolean $checkCapacity |
||
| 181 | * @return void |
||
| 182 | */ |
||
| 183 | protected function addLink($menu, $menuLink, $isInSubMenu = false, $checkCapacity = true) |
||
| 184 | { |
||
| 185 | // Retrieve module if defined |
||
| 186 | $module = isset($menuLink->module) ? ucmodule($menuLink->module) : null; |
||
| 187 | |||
| 188 | //TODO: Check needed capacity |
||
| 189 | if ($menuLink->type === 'module' && !is_null($module)) { |
||
| 190 | // Don't display domain module if multi domains is not activated |
||
| 191 | if ($module->name === 'domain' && !env('UCCELLO_MULTI_DOMAINS', true)) { |
||
| 192 | return; |
||
| 193 | } |
||
| 194 | |||
| 195 | if (!$module->isActiveOnDomain($this->domain)) { |
||
| 196 | return; |
||
| 197 | } |
||
| 198 | if ($checkCapacity && !auth()->user()->canRetrieve($this->domain, $module)) { |
||
| 199 | return; |
||
| 200 | } |
||
| 201 | } |
||
| 202 | |||
| 203 | if (!empty($menuLink->module)) { |
||
| 204 | if (!in_array($menuLink->module, $this->menuAddedModules)) { |
||
| 205 | $this->menuAddedModules[ ] = $menuLink->module; |
||
| 206 | } |
||
| 207 | } |
||
| 208 | |||
| 209 | // Url |
||
| 210 | if (!empty($menuLink->url)) { // Prioritary to be compatible with addActiveModuleIfNotInMenu() |
||
| 211 | $url = $menuLink->url; |
||
| 212 | } elseif (!empty($menuLink->route) && !is_null($module)) { |
||
| 213 | $url = ucroute($menuLink->route, $this->domain, $module); |
||
| 214 | } else { |
||
| 215 | $url = 'javascript:void(0)'; |
||
| 216 | } |
||
| 217 | |||
| 218 | // Label |
||
| 219 | $label = $menuLink->type === 'module' ? uctrans($menuLink->label, $module) : uctrans($menuLink->label, $this->module); |
||
| 220 | if (!is_string($label)) { |
||
| 221 | return; |
||
| 222 | } |
||
| 223 | |||
| 224 | // Icon |
||
| 225 | if ($menuLink->type === 'folder') { |
||
| 226 | $fallbackIcon = 'folder'; |
||
| 227 | } elseif ($menuLink->type === 'link') { |
||
| 228 | $fallbackIcon = 'link'; |
||
| 229 | } else { |
||
| 230 | $fallbackIcon = 'extension'; |
||
| 231 | } |
||
| 232 | |||
| 233 | $icon = $menuLink->icon ?? $fallbackIcon; |
||
| 234 | |||
| 235 | // Is active. If the current route is in the menu, compare also the routes |
||
| 236 | if ($menuLink->type === 'module' && !is_null($module)) { |
||
| 237 | if ($this->isCurrentRouteInMenu($module)) { |
||
| 238 | $isActive = $this->module->id === $module->id && request()->route()->getName() === $menuLink->route; |
||
| 239 | } else { |
||
| 240 | $isActive = $this->module->id === $module->id; |
||
| 241 | } |
||
| 242 | } else { |
||
| 243 | $isActive = false; |
||
| 244 | } |
||
| 245 | |||
| 246 | // Add children |
||
| 247 | if (!empty($menuLink->children)) { |
||
| 248 | |||
| 249 | // Make a sub menu |
||
| 250 | $subMenu = Menu::new(); |
||
| 251 | |||
| 252 | // Add all links in the sub menu |
||
| 253 | foreach ($menuLink->children as $subMenuLink) { |
||
| 254 | $this->addLink($subMenu, $subMenuLink, true); // Recursive |
||
| 255 | } |
||
| 256 | |||
| 257 | if ($subMenu->count() > 0) { |
||
| 258 | $link = Html::raw( |
||
| 259 | '<ul class="collapsible collapsible-accordion">'. |
||
| 260 | '<li class="submenu">'. |
||
| 261 | '<a href="'.$url.'" class="collapsible-header waves-effect" tabindex="0">'. |
||
| 262 | '<i class="material-icons">'.$icon.'</i>'. |
||
| 263 | '<span>'.$label.'</span>'. |
||
| 264 | '</a>'. |
||
| 265 | '<div class="collapsible-body">'. |
||
| 266 | $subMenu->toHtml(). |
||
| 267 | '</div>'. |
||
| 268 | '</li>'. |
||
| 269 | '</ul>' |
||
| 270 | ); |
||
| 271 | |||
| 272 | $menu->add($link); |
||
| 273 | } |
||
| 274 | |||
| 275 | } else { |
||
| 276 | $link = Html::raw( |
||
| 277 | '<a href="'.$url.'">'. |
||
| 278 | '<i class="material-icons">'.$icon.'</i>'. |
||
| 279 | '<span>'.$label.'</span>'. |
||
| 280 | '</a>' |
||
| 281 | )->setActive($isActive); |
||
| 282 | |||
| 283 | // Add link to menu |
||
| 284 | $menu->add($link); |
||
| 285 | } |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Return the menu to display according to the environment (main or admin) |
||
| 290 | * |
||
| 291 | * @return \Uccello\Core\Models\Menu |
||
| 292 | */ |
||
| 293 | protected function getDomainMenuToDisplay() |
||
| 294 | { |
||
| 295 | if ($this->isAdminEnv()) { |
||
| 296 | $menuToDisplay = $this->domain->adminMenu; |
||
| 297 | } else { |
||
| 298 | $menuToDisplay = $this->domain->mainMenu; |
||
| 299 | } |
||
| 300 | |||
| 301 | return $menuToDisplay; |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Return all modules visible in the menu according to the environment (main or admin) |
||
| 306 | * |
||
| 307 | * @return void |
||
| 308 | */ |
||
| 309 | protected function getModulesVisibleInMenu() |
||
| 310 | { |
||
| 311 | // Detect what sort of link to add in the menu (admin or not admin) and load the related modules |
||
| 312 | if ($this->isAdminEnv()) { |
||
| 313 | $modules = $this->domain->adminModules; |
||
| 314 | } else { |
||
| 315 | $modules = $this->domain->notAdminModules; |
||
| 316 | } |
||
| 317 | |||
| 318 | return $modules; |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Check if we are in the admin environment |
||
| 323 | * |
||
| 324 | * @return boolean |
||
| 325 | */ |
||
| 326 | protected function isAdminEnv() |
||
| 329 | } |
||
| 330 | |||
| 331 | /** |
||
| 332 | * Check if the current route is present in the menu |
||
| 333 | * |
||
| 334 | * @param \Uccello\Core\Models\Module $module |
||
| 335 | * @return boolean |
||
| 336 | */ |
||
| 337 | protected function isCurrentRouteInMenu($module) |
||
| 342 | } |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Check if a route is present in the menu |
||
| 346 | * |
||
| 347 | * @param \Uccello\Core\Models\Module $module |
||
| 348 | * @param string $route |
||
| 349 | * @return boolean |
||
| 350 | */ |
||
| 351 | protected function isRouteInMenu($module, $route) |
||
| 365 | } |
||
| 366 | } |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths