-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #784 Added a new feature to create custom menus (javiereguiluz)
This PR was squashed before being merged into the master branch (closes #784). Discussion ---------- Added a new feature to create custom menus **VERY IMPORTANT**: this article explains a feature that DOESN'T EXIST YET in EasyAdmin. Don't try to use this feature. It won't work! --- Following our "DDD tradition" (*Documentation-Driven Development*), I've created a tutorial for an imaginary feature that allows to define custom menus. For all those developers that need this feature, please add your comments and try to reply to these questions * If this feature was real, would it solve your menu-related needs? * If yes, could we simplify it? * If no, what does it lack? * Do you know any good-practice related to menus that we could import from other projects (KnpMenuBundle, Sonata, ...) or technologies (Django, Rails, ...)? Thanks! Commits ------- 70de83a Added a new feature to create custom menus
- Loading branch information
Showing
162 changed files
with
3,599 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the EasyAdminBundle. | ||
| * | ||
| * (c) Javier Eguiluz <javier.eguiluz@gmail.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace JavierEguiluz\Bundle\EasyAdminBundle\Configuration; | ||
|
|
||
| /** | ||
| * Processes the main menu configuration defined in the "design.menu" | ||
| * option or creates the default config for the menu if none is defined. | ||
| * | ||
| * @author Javier Eguiluz <javier.eguiluz@gmail.com> | ||
| */ | ||
| class MenuConfigPass implements ConfigPassInterface | ||
| { | ||
| public function process(array $backendConfig) | ||
| { | ||
| // process 1st level menu items | ||
| $menuConfig = $backendConfig['design']['menu']; | ||
| $menuConfig = $this->normalizeMenuConfig($menuConfig, $backendConfig); | ||
| $menuConfig = $this->processMenuConfig($menuConfig, $backendConfig); | ||
|
|
||
| $backendConfig['design']['menu'] = $menuConfig; | ||
|
|
||
| // process 2nd level menu items (i.e. submenus) | ||
| foreach ($backendConfig['design']['menu'] as $i => $itemConfig) { | ||
| if (empty($itemConfig['children'])) { | ||
| continue; | ||
| } | ||
|
|
||
| $submenuConfig = $itemConfig['children']; | ||
| $submenuConfig = $this->normalizeMenuConfig($submenuConfig, $backendConfig, $i); | ||
| $submenuConfig = $this->processMenuConfig($submenuConfig, $backendConfig, $i); | ||
|
|
||
| $backendConfig['design']['menu'][$i]['children'] = $submenuConfig; | ||
| } | ||
|
|
||
| return $backendConfig; | ||
| } | ||
|
|
||
| /** | ||
| * Normalizes the different shortcut notations of the menu config to simplify | ||
| * further processing. | ||
| * | ||
| * @param array $menuConfig | ||
| * @param array $backendConfig | ||
| * @param int $parentItemIndex The index of the parent item for this menu item (allows to treat submenus differently) | ||
| * | ||
| * @return array | ||
| */ | ||
| private function normalizeMenuConfig(array $menuConfig, array $backendConfig, $parentItemIndex = -1) | ||
| { | ||
| // if the backend doesn't define the menu configuration: create a default | ||
| // menu configuration to display all its entities | ||
| if (empty($menuConfig)) { | ||
| foreach ($backendConfig['entities'] as $entityName => $entityConfig) { | ||
| $menuConfig[] = array('entity' => $entityName, 'label' => $entityConfig['label']); | ||
| } | ||
| } | ||
|
|
||
| // replaces the short config syntax: | ||
| // design.menu: ['Product', 'User'] | ||
| // by the expanded config syntax: | ||
| // design.menu: []{ entity: 'Product' }, { entity: 'User' }] | ||
| foreach ($menuConfig as $i => $itemConfig) { | ||
| if (is_string($itemConfig)) { | ||
| $itemConfig = array('entity' => $itemConfig); | ||
| } | ||
|
|
||
| $menuConfig[$i] = $itemConfig; | ||
| } | ||
|
|
||
| foreach ($menuConfig as $i => $itemConfig) { | ||
| // normalize icon configuration | ||
| if (!array_key_exists('icon', $itemConfig)) { | ||
| $itemConfig['icon'] = ($parentItemIndex > -1) ? 'fa-chevron-right' : 'fa-chevron-circle-right'; | ||
| } elseif (empty($itemConfig['icon'])) { | ||
| $itemConfig['icon'] = null; | ||
| } else { | ||
| $itemConfig['icon'] = 'fa-'.$itemConfig['icon']; | ||
| } | ||
|
|
||
| // normalize submenu configuration (only for main menu items) | ||
| if (!isset($itemConfig['children']) && $parentItemIndex === -1) { | ||
| $itemConfig['children'] = array(); | ||
| } | ||
|
|
||
| // normalize 'default' option, which sets the menu item used as the backend index | ||
| if (!array_key_exists('default', $itemConfig)) { | ||
| $itemConfig['default'] = false; | ||
| } else { | ||
| $itemConfig['default'] = (bool) $itemConfig['default']; | ||
| } | ||
|
|
||
| $menuConfig[$i] = $itemConfig; | ||
| } | ||
|
|
||
| return $menuConfig; | ||
| } | ||
|
|
||
| private function processMenuConfig(array $menuConfig, array $backendConfig, $parentItemIndex = -1) | ||
| { | ||
| foreach ($menuConfig as $i => $itemConfig) { | ||
| // these options are needed to find the active menu/submenu item in the template | ||
| $itemConfig['menu_index'] = ($parentItemIndex === -1) ? $i : $parentItemIndex; | ||
| $itemConfig['submenu_index'] = ($parentItemIndex === -1) ? -1 : $i; | ||
|
|
||
| // 1st level priority: if 'entity' is defined, link to the given entity | ||
| if (isset($itemConfig['entity'])) { | ||
| $itemConfig['type'] = 'entity'; | ||
| $entityName = $itemConfig['entity']; | ||
|
|
||
| if (!array_key_exists($entityName, $backendConfig['entities'])) { | ||
| throw new \RuntimeException(sprintf('The "%s" entity included in the "menu" option is not managed by EasyAdmin. The menu can only include any of these entities: %s.', $entityName, implode(', ', array_keys($backendConfig['entities'])))); | ||
| } | ||
|
|
||
| if (!isset($itemConfig['label'])) { | ||
| $itemConfig['label'] = $backendConfig['entities'][$entityName]['label']; | ||
| } | ||
|
|
||
| if (!isset($itemConfig['params'])) { | ||
| $itemConfig['params'] = array(); | ||
| } | ||
| } | ||
|
|
||
| // 2nd level priority: if 'url' is defined, link to the given absolute/relative URL | ||
| elseif (isset($itemConfig['url'])) { | ||
| $itemConfig['type'] = 'link'; | ||
|
|
||
| if (!isset($itemConfig['label'])) { | ||
| throw new \RuntimeException(sprintf('The configuration of the menu item with "url = %s" must define the "label" option.', $itemConfig['url'])); | ||
| } | ||
| } | ||
|
|
||
| // 3rd level priority: if 'route' is defined, link to the path generated with the given route | ||
| elseif (isset($itemConfig['route'])) { | ||
| $itemConfig['type'] = 'route'; | ||
|
|
||
| if (!isset($itemConfig['label'])) { | ||
| throw new \RuntimeException(sprintf('The configuration of the menu item with "route = %s" must define the "label" option.', $itemConfig['route'])); | ||
| } | ||
|
|
||
| if (!isset($itemConfig['params'])) { | ||
| $itemConfig['params'] = array(); | ||
| } | ||
| } | ||
|
|
||
| // 4th level priority: if 'label' is defined (and not the previous options), this is an empty element | ||
| elseif (isset($itemConfig['label'])) { | ||
| $itemConfig['type'] = 'empty'; | ||
| } | ||
|
|
||
| else { | ||
| throw new \RuntimeException(sprintf('The configuration of the menu item in the position %d (being 0 the first item) must define at least one of these options: entity, url, route, label.', $i)); | ||
| } | ||
|
|
||
| $menuConfig[$i] = $itemConfig; | ||
| } | ||
|
|
||
| return $menuConfig; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.