ElggMenuItem.php

Go to the documentation of this file.

<?php
#[\AllowDynamicProperties]
class ElggMenuItem implements \Elgg\Collections\CollectionItemInterface {

    protected $data = [
        // string Identifier of the menu
        'name' => '',

        // array Page contexts this menu item should appear on
        'contexts' => ['all'],

        // string Menu section identifier
        'section' => 'default',

        // int Smaller priorities float to the top
        'priority' => 100,

        // bool Is this the currently selected menu item (null for autodetection)
        'selected' => null,

        // string Identifier of this item's parent
        'parent_name' => '',

        // boolean Indicator to control if menu item should show if it has no children
        'show_with_empty_children' => true,

        // \ElggMenuItem The parent object or null
        'parent' => null,

        // array Array of children objects or empty array
        'children' => [],

        // array An array of options for child menu of the parent item
        'child_menu' => [],

        // array Classes to apply to the li tag
        'itemClass' => [],

        // array Classes to apply to the anchor tag
        'linkClass' => [],

        // array ES modules required by this menu item
        'deps' => [],
        
        // which view should be used to output the menu item contents
        'item_contents_view' => null,
    ];

    protected $text;

    protected $href = null;

    protected $title = false;

    protected $confirm = '';

    public function __construct($name, $text, $href) {
        $this->text = $text;
        if ($href) {
            $this->href = elgg_normalize_url($href);
        } else {
            $this->href = $href;
        }

        $this->data['name'] = $name;
    }

    public static function factory(array $options): \ElggMenuItem {
        if (!isset($options['name']) || !isset($options['text'])) {
            throw new \Elgg\Exceptions\InvalidArgumentException(__METHOD__ . ': $options "name" and "text" are required.');
        }
        
        if (!isset($options['href'])) {
            $options['href'] = '';
        }

        $item = new \ElggMenuItem($options['name'], $options['text'], $options['href']);
        unset($options['name']);
        unset($options['text']);
        unset($options['href']);

        // special catch in case someone uses context rather than contexts
        if (isset($options['context'])) {
            $options['contexts'] = $options['context'];
            unset($options['context']);
        }
        
        // make sure contexts is set correctly
        if (isset($options['contexts'])) {
            $item->setContext($options['contexts']);
            unset($options['contexts']);
        }

        if (isset($options['link_class'])) {
            $item->setLinkClass($options['link_class']);
            unset($options['link_class']);
        }

        if (isset($options['item_class'])) {
            $item->setItemClass($options['item_class']);
            unset($options['item_class']);
        }

        if (isset($options['data']) && is_array($options['data'])) {
            $item->setData($options['data']);
            unset($options['data']);
        }
        
        foreach ($options as $key => $value) {
            if (array_key_exists($key, $item->data)) {
                $item->data[$key] = $value;
            } else {
                $item->$key = $value;
            }
        }

        return $item;
    }

    public function setData($key, $value = null) {
        if (is_array($key)) {
            $this->data = array_merge($this->data, $key);
        } else {
            $this->data[$key] = $value;
        }
    }

    public function getData($key) {
        return $this->data[$key] ?? null;
    }

    public function setName($name) {
        $this->data['name'] = $name;
    }

    public function getName() {
        return $this->data['name'];
    }

    public function setText($text) {
        $this->text = $text;
    }

    public function getText() {
        return $this->text;
    }

    public function setHref($href) {
        $this->href = $href;
    }

    public function getHref() {
        return $this->href;
    }

    public function setContext($contexts) {
        if (is_string($contexts)) {
            $contexts = [$contexts];
        }
        
        $this->data['contexts'] = $contexts;
    }

    public function getContext() {
        return $this->data['contexts'];
    }

    public function inContext($context = '') {
        if (in_array('all', $this->data['contexts'])) {
            return true;
        }

        if ($context) {
            return in_array($context, $this->data['contexts']);
        }

        foreach ($this->data['contexts'] as $context) {
            if (elgg_in_context($context)) {
                return true;
            }
        }

        return false;
    }

    public function setSelected($state = true) {
        $this->data['selected'] = $state;
    }

    public function getSelected() {
        if (isset($this->data['selected'])) {
            return $this->data['selected'];
        }
        
        $href = $this->getHref();
        if ($href === false) {
            return false;
        }

        return elgg_http_url_is_identical(elgg_get_current_url(), $href);
    }

    public function setTooltip($text) {
        $this->title = $text;
    }

    public function getTooltip() {
        return $this->title;
    }

    public function setConfirmText($text) {
        $this->confirm = $text;
    }

    public function getConfirmText() {
        return $this->confirm;
    }

    public function setLinkClass($class) {
        if (!is_array($class)) {
            $this->data['linkClass'] = [$class];
        } else {
            $this->data['linkClass'] = $class;
        }
    }

    public function getLinkClass() {
        return implode(' ', $this->data['linkClass']);
    }

    public function addLinkClass($class) {
        $this->addClass($this->data['linkClass'], $class);
    }

    public function setDeps($modules) {
        $this->data['deps'] = (array) $modules;
    }

    public function getDeps() {
        $modules = (array) $this->data['deps'];
        return array_filter($modules, function($m) {
            return is_string($m) && !empty($m);
        });
    }

    public function addDeps($modules) {
        $current = $this->getDeps();
        $this->setDeps($current + (array) $modules);
    }

    public function setChildMenuOptions(array $options = []) {
        $this->data['child_menu'] = $options;
    }

    public function getChildMenuOptions() {
        return $this->data['child_menu'];
    }

    public function setItemClass($class) {
        if (!is_array($class)) {
            $this->data['itemClass'] = [$class];
        } else {
            $this->data['itemClass'] = $class;
        }
    }

    public function getItemClass() {
        // allow people to specify name with underscores and colons
        $name = preg_replace('/[^a-z0-9\-]/i', '-', strtolower($this->getName()));
        
        $class = implode(' ', $this->data['itemClass']);
        if ($class) {
            return "elgg-menu-item-$name $class";
        } else {
            return "elgg-menu-item-$name";
        }
    }

    public function addItemClass($class) {
        $this->addClass($this->data['itemClass'], $class);
    }

    protected function addClass(array &$current, $additional) {
        if (!is_array($additional)) {
            $current[] = $additional;
        } else {
            $current = array_merge($current, $additional);
        }
    }

    public function setPriority(int $priority) {
        $this->data['priority'] = $priority;
    }

    public function getPriority() {
        return (int) $this->data['priority'];
    }

    public function setSection($section) {
        $this->data['section'] = $section;
    }

    public function getSection() {
        return $this->data['section'];
    }

    public function setParentName($name) {
        $this->data['parent_name'] = $name;
    }

    public function getParentName() {
        return $this->data['parent_name'];
    }

    public function setParent($parent) {
        $this->data['parent'] = $parent;
    }

    public function getParent() {
        return $this->data['parent'];
    }

    public function addChild($item) {
        $this->data['children'][] = $item;
    }

    public function setChildren($children) {
        $this->data['children'] = $children;
    }

    public function getChildren() {
        return $this->data['children'];
    }

    public function sortChildren($sortFunction) {
        foreach ($this->data['children'] as $key => $node) {
            $node->data['original_order'] = $key;
            $node->sortChildren($sortFunction);
        }
        
        usort($this->data['children'], $sortFunction);
    }

    public function getValues() {
        $values = get_object_vars($this);
        unset($values['data']);

        return $values;
    }

    public function getID() {
        return $this->getName();
    }
    
    public function setItemContentsView(string $view_name): void {
        $this->data['item_contents_view'] = $view_name;
    }
    
    public function getItemContentsView(): ?string {
        return $this->data['item_contents_view'];
    }
    
    public function hasItemContentsView(): bool {
        return isset($this->data['item_contents_view']);
    }
}