Service.php

Go to the documentation of this file.

<?php

namespace Elgg\Menu;

use Elgg\Config;
use Elgg\EventsService;

class Service {

    protected $menus = [];

    public function __construct(protected EventsService $events, protected Config $config) {
    }

    public function getMenu(string $name, array $params = []): Menu {
        return $this->prepareMenu($this->getUnpreparedMenu($name, $params));
    }

    public function getUnpreparedMenu(string $name, array $params = []): UnpreparedMenu {
        $items = $this->prepareMenuItems(elgg_extract('items', $params, []));
        unset($params['items']);

        $registered_items = elgg_extract($name, $this->menus);
        if (is_array($registered_items)) {
            $items->merge($registered_items);
        }

        $params['name'] = $name;

        $params = $this->events->triggerResults('parameters', "menu:{$name}", $params, $params);

        if (!isset($params['sort_by'])) {
            $params['sort_by'] = 'priority';
        }

        // trigger specific menu events
        $entity = elgg_extract('entity', $params);
        if ($entity instanceof \ElggEntity) {
            $items = $this->events->triggerResults('register', "menu:{$name}:{$entity->type}:{$entity->subtype}", $params, $items);
        }

        $annotation = elgg_extract('annotation', $params);
        if ($annotation instanceof \ElggAnnotation) {
            $items = $this->events->triggerResults('register', "menu:{$name}:{$annotation->getType()}:{$annotation->getSubtype()}", $params, $items);
        }

        $relationship = elgg_extract('relationship', $params);
        if ($relationship instanceof \ElggRelationship) {
            $items = $this->events->triggerResults('register', "menu:{$name}:{$relationship->getType()}:{$relationship->getSubtype()}", $params, $items);
        }

        // trigger generic menu event
        $items = $this->events->triggerResults('register', "menu:{$name}", $params, $items);

        return new UnpreparedMenu($params, $items);
    }

    public function prepareMenu(UnpreparedMenu $menu): Menu {
        $name = $menu->getName();
        $params = $menu->getParams();
        $sort_by = $menu->getSortBy();
        $selected_menu_item_name = elgg_extract('selected_item_name', $params, '');
        
        $builder = new \ElggMenuBuilder($menu->getItems());
        $builder->setSelected($selected_menu_item_name);
        
        $params['menu'] = $builder->getMenu($sort_by);
        $params['selected_item'] = $builder->getSelected();

        // trigger specific menu events
        $entity = elgg_extract('entity', $params);
        if ($entity instanceof \ElggEntity) {
            $params['menu'] = $this->events->triggerResults('prepare', "menu:{$name}:{$entity->type}:{$entity->subtype}", $params, $params['menu']);
        }

        $annotation = elgg_extract('annotation', $params);
        if ($annotation instanceof \ElggAnnotation) {
            $params['menu'] = $this->events->triggerResults('prepare', "menu:{$name}:{$annotation->getType()}:{$annotation->getSubtype()}", $params, $params['menu']);
        }

        $relationship = elgg_extract('relationship', $params);
        if ($relationship instanceof \ElggRelationship) {
            $params['menu'] = $this->events->triggerResults('prepare', "menu:{$name}:{$relationship->getType()}:{$relationship->getSubtype()}", $params, $params['menu']);
        }

        // trigger generic menu event
        $params['menu'] = $this->events->triggerResults('prepare', "menu:$name", $params, $params['menu']);
        
        $params['menu'] = $this->prepareVerticalMenu($params['menu'], $params);
        $params['menu'] = $this->prepareDropdownMenu($params['menu'], $params);
        $params['menu'] = $this->prepareSelectedParents($params['menu'], $params);
        $params['menu'] = $this->prepareItemContentsView($params['menu'], $params);
        
        return new Menu($params);
    }
    
    protected function prepareVerticalMenu(PreparedMenu $menu, array $params): PreparedMenu {
        if (elgg_extract('prepare_vertical', $params) !== true) {
            return $menu;
        }
        
        $prepare = function(\ElggMenuItem $menu_item) use (&$prepare) {
            $child_menu_vars = $menu_item->getChildMenuOptions();
            if (empty($child_menu_vars['display'])) {
                $child_menu_vars['display'] = 'toggle';
            }
            
            $menu_item->setChildMenuOptions($child_menu_vars);
            
            foreach ($menu_item->getChildren() as $child_menu_item) {
                $prepare($child_menu_item);
            }
        };
        
        /* @var $section MenuSection */
        foreach ($menu as $section) {
            /* @var $menu_item \ElggMenuItem */
            foreach ($section as $menu_item) {
                $prepare($menu_item);
            }
        }
        
        return $menu;
    }

    protected function prepareSelectedParents(PreparedMenu $menu, array $params): PreparedMenu {
        $selected_item = elgg_extract('selected_item', $params);
        if (!$selected_item instanceof \ElggMenuItem) {
            return $menu;
        }
        
        $parent = $selected_item->getParent();
        while ($parent instanceof \ElggMenuItem) {
            $parent->setSelected();
            $parent->addItemClass('elgg-has-selected-child');
            $parent = $parent->getParent();
        }
    
        return $menu;
    }

    protected function prepareDropdownMenu(PreparedMenu $menu, array $params): PreparedMenu {
        if (elgg_extract('prepare_dropdown', $params) !== true) {
            return $menu;
        }
        
        $items = $menu->getItems('default');
        if (empty($items)) {
            return $menu;
        }
        
        $menu_name = elgg_extract('name', $params);
        $menu->getSection('default')->fill([
            \ElggMenuItem::factory([
                'name' => 'entity-menu-toggle',
                'icon' => 'ellipsis-v',
                'href' => false,
                'text' => '',
                'title' => elgg_echo('more'),
                'child_menu' => [
                    'display' => 'dropdown',
                    'data-position' => json_encode([
                        'at' => 'right bottom',
                        'my' => 'right top',
                        'collision' => 'fit fit',
                    ]),
                    'class' => "elgg-{$menu_name}-dropdown-menu",
                ],
                'children' => $items,
            ]),
        ]);
        
        return $menu;
    }
    
    protected function prepareItemContentsView(PreparedMenu $menu, array $params): PreparedMenu {
        $item_contents_view = elgg_extract('item_contents_view', $params, 'navigation/menu/elements/item/url');
        
        $prepare = function(\ElggMenuItem $menu_item) use (&$prepare, $item_contents_view) {
            if (!$menu_item->hasItemContentsView()) {
                $menu_item->setItemContentsView($item_contents_view);
            }
            
            foreach ($menu_item->getChildren() as $child_menu_item) {
                $prepare($child_menu_item);
            }
        };
        
        /* @var $section MenuSection */
        foreach ($menu as $section) {
            /* @var $menu_item \ElggMenuItem */
            foreach ($section as $menu_item) {
                $prepare($menu_item);
            }
        }
        
        return $menu;
    }

    public function combineMenus(array $names = [], array $params = [], string $new_name = ''): UnpreparedMenu {
        if (!$new_name) {
            $new_name = implode('__', $names);
        }

        $all_items = new MenuItems();

        foreach ($names as $name) {
            $items = $this->getUnpreparedMenu($name, $params)->getItems();

            /* @var $item \ElggMenuItem */
            foreach ($items as $item) {
                $section = $item->getSection();
                if ($section === 'default') {
                    $item->setSection($name);
                }
                
                $item->setData('menu_name', $name);

                $all_items->add($item);
            }
        }

        $params['name'] = $new_name;

        return new UnpreparedMenu($params, $all_items);
    }

    public function prepareMenuItems(array $items = []): MenuItems {
        $prepared_items = new MenuItems();

        foreach ($items as $item) {
            if (is_array($item)) {
                $options = $item;
                $item = \ElggMenuItem::factory($options);
            }

            if (!$item instanceof \ElggMenuItem) {
                continue;
            }

            $prepared_items->add($item);
        }

        return $prepared_items;
    }
    
    public function registerMenuItem(string $menu_name, \ElggMenuItem $menu_item): void {
        $this->menus[$menu_name][] = $menu_item;
    }
    
    public function unregisterMenuItem(string $menu_name, string $item_name): ?\ElggMenuItem {
        if (!isset($this->menus[$menu_name])) {
            return null;
        }
        
        foreach ($this->menus[$menu_name] as $index => $menu_item) {
            if ($menu_item->getName() === $item_name) {
                $item = $this->menus[$menu_name][$index];
                unset($this->menus[$menu_name][$index]);
                return $item;
            }
        }
        
        return null;
    }
    
    public function getAllMenus(): array {
        return $this->menus;
    }
}