navigation.php

Go to the documentation of this file.

<?php
function elgg_register_menu_item($menu_name, $menu_item) {
    global $CONFIG;

    if (is_array($menu_item)) {
        $options = $menu_item;
        $menu_item = \ElggMenuItem::factory($options);
        if (!$menu_item) {
            $menu_item_name = elgg_extract('name', $options, 'MISSING NAME');
            elgg_log("Unable to add menu item '{$menu_item_name}' to '$menu_name' menu", 'WARNING');
            return false;
        }
    }

    if (!$menu_item instanceof ElggMenuItem) {
        elgg_log('Second argument of elgg_register_menu_item() must be an instance of '
            . 'ElggMenuItem or an array of menu item factory options', 'ERROR');
        return false;
    }

    if (!isset($CONFIG->menus[$menu_name])) {
        $CONFIG->menus[$menu_name] = array();
    }
    $CONFIG->menus[$menu_name][] = $menu_item;
    return true;
}

function elgg_unregister_menu_item($menu_name, $item_name) {
    global $CONFIG;

    if (empty($CONFIG->menus[$menu_name])) {
        return null;
    }

    foreach ($CONFIG->menus[$menu_name] as $index => $menu_object) {
        /* @var \ElggMenuItem $menu_object */
        if ($menu_object instanceof ElggMenuItem && $menu_object->getName() == $item_name) {
            $item = $CONFIG->menus[$menu_name][$index];
            unset($CONFIG->menus[$menu_name][$index]);
            return $item;
        }
    }

    return null;
}

function elgg_is_menu_item_registered($menu_name, $item_name) {
    global $CONFIG;

    if (!isset($CONFIG->menus[$menu_name])) {
        return false;
    }

    foreach ($CONFIG->menus[$menu_name] as $menu_object) {
        /* @var \ElggMenuItem $menu_object */
        if ($menu_object->getName() == $item_name) {
            return true;
        }
    }

    return false;
}

function elgg_get_menu_item($menu_name, $item_name) {
    global $CONFIG;

    if (!isset($CONFIG->menus[$menu_name])) {
        return null;
    }

    foreach ($CONFIG->menus[$menu_name] as $index => $menu_object) {
        /* @var \ElggMenuItem $menu_object */
        if ($menu_object->getName() == $item_name) {
            return $CONFIG->menus[$menu_name][$index];
        }
    }

    return null;
}

function elgg_register_title_button($handler = null, $name = 'add', $entity_type = 'all', $entity_subtype = 'all') {
    
    if (!$handler) {
        $handler = elgg_get_context();
    }

    $owner = elgg_get_page_owner_entity();
    if (!$owner) {
        // noone owns the page so this is probably an all site list page
        $owner = elgg_get_logged_in_user_entity();
    }
    if (!$owner || !$owner->canWriteToContainer(0, $entity_type, $entity_subtype)) {
        return;
    }

    elgg_register_menu_item('title', array(
        'name' => $name,
        'href' => "$handler/$name/$owner->guid",
        'text' => elgg_echo("$handler:$name"),
        'link_class' => 'elgg-button elgg-button-action',
    ));
}

function elgg_push_breadcrumb($title, $link = null) {
    global $CONFIG;
    if (!isset($CONFIG->breadcrumbs)) {
        $CONFIG->breadcrumbs = array();
    }

    $CONFIG->breadcrumbs[] = array('title' => $title, 'link' => $link);
}

function elgg_pop_breadcrumb() {
    global $CONFIG;

    if (empty($CONFIG->breadcrumbs) || !is_array($CONFIG->breadcrumbs)) {
        return array();
    }
    return array_pop($CONFIG->breadcrumbs);
}

function elgg_get_breadcrumbs() {
    global $CONFIG;

    // if no crumbs set, still allow hook to populate it
    if (isset($CONFIG->breadcrumbs) && is_array($CONFIG->breadcrumbs)) {
        $breadcrumbs = $CONFIG->breadcrumbs;
    } else {
        $breadcrumbs = array();
    }

    $params = array(
        'breadcrumbs' => $breadcrumbs,
    );
    $breadcrumbs = elgg_trigger_plugin_hook('prepare', 'breadcrumbs', $params, $breadcrumbs);
    if (!is_array($breadcrumbs)) {
        return array();
    }

    return $breadcrumbs;
}

function elgg_prepare_breadcrumbs($hook, $type, $breadcrumbs, $params) {
    // remove last crumb if not a link
    $last_crumb = end($breadcrumbs);
    if (empty($last_crumb['link'])) {
        array_pop($breadcrumbs);
    }

    // apply excerpt to titles
    foreach (array_keys($breadcrumbs) as $i) {
        $breadcrumbs[$i]['title'] = elgg_get_excerpt($breadcrumbs[$i]['title'], 100);
    }
    return $breadcrumbs;
}

function _elgg_site_menu_setup($hook, $type, $return, $params) {

    $featured_menu_names = elgg_get_config('site_featured_menu_names');
    $custom_menu_items = elgg_get_config('site_custom_menu_items');
    if ($featured_menu_names || $custom_menu_items) {
        // we have featured or custom menu items

        $registered = $return['default'];
        /* @var \ElggMenuItem[] $registered */

        // set up featured menu items
        $featured = array();
        foreach ($featured_menu_names as $name) {
            foreach ($registered as $index => $item) {
                if ($item->getName() == $name) {
                    $featured[] = $item;
                    unset($registered[$index]);
                }
            }
        }

        // add custom menu items
        $n = 1;
        foreach ($custom_menu_items as $title => $url) {
            $item = new \ElggMenuItem("custom$n", $title, $url);
            $featured[] = $item;
            $n++;
        }

        $return['default'] = $featured;
        if (count($registered) > 0) {
            $return['more'] = $registered;
        }
    } else {
        // no featured menu items set
        $max_display_items = 5;

        // the first n are shown, rest added to more list
        // if only one item on more menu, stick it with the rest
        $num_menu_items = count($return['default']);
        if ($num_menu_items > ($max_display_items + 1)) {
            $return['more'] = array_splice($return['default'], $max_display_items);
        }
    }
    
    // check if we have anything selected
    $selected = false;
    foreach ($return as $section) {
        /* @var \ElggMenuItem[] $section */

        foreach ($section as $item) {
            if ($item->getSelected()) {
                $selected = true;
                break 2;
            }
        }
    }
    
    if (!$selected) {
        // nothing selected, match name to context or match url
        $current_url = current_page_url();
        foreach ($return as $section_name => $section) {
            foreach ($section as $key => $item) {
                // only highlight internal links
                if (strpos($item->getHref(), elgg_get_site_url()) === 0) {
                    if ($item->getName() == elgg_get_context()) {
                        $return[$section_name][$key]->setSelected(true);
                        break 2;
                    }
                    if ($item->getHref() == $current_url) {
                        $return[$section_name][$key]->setSelected(true);
                        break 2;
                    }
                }
            }
        }
    }

    return $return;
}

function _elgg_river_menu_setup($hook, $type, $return, $params) {
    if (elgg_is_logged_in()) {
        $item = $params['item'];
        /* @var \ElggRiverItem $item */
        $object = $item->getObjectEntity();
        // add comment link but annotations cannot be commented on
        if ($item->annotation_id == 0) {
            if ($object->canComment()) {
                $options = array(
                    'name' => 'comment',
                    'href' => "#comments-add-{$object->guid}-{$item->id}",
                    'text' => elgg_view_icon('speech-bubble'),
                    'title' => elgg_echo('comment:this'),
                    'rel' => 'toggle',
                    'priority' => 50,
                );
                $return[] = \ElggMenuItem::factory($options);
            }
        }
        
        if ($item->canDelete()) {
            $options = array(
                'name' => 'delete',
                'href' => elgg_add_action_tokens_to_url("action/river/delete?id={$item->id}"),
                'text' => elgg_view_icon('delete'),
                'title' => elgg_echo('river:delete'),
                'confirm' => elgg_echo('deleteconfirm'),
                'priority' => 200,
            );
            $return[] = \ElggMenuItem::factory($options);
        }
    }

    return $return;
}

function _elgg_entity_menu_setup($hook, $type, $return, $params) {
    if (elgg_in_context('widgets')) {
        return $return;
    }
    
    $entity = $params['entity'];
    /* @var \ElggEntity $entity */
    $handler = elgg_extract('handler', $params, false);

    // access
    if (elgg_is_logged_in()) {
        $access = elgg_view('output/access', array('entity' => $entity));
        $options = array(
            'name' => 'access',
            'text' => $access,
            'href' => false,
            'priority' => 100,
        );
        $return[] = \ElggMenuItem::factory($options);
    }
    
    if ($entity->canEdit() && $handler) {
        // edit link
        $options = array(
            'name' => 'edit',
            'text' => elgg_echo('edit'),
            'title' => elgg_echo('edit:this'),
            'href' => "$handler/edit/{$entity->getGUID()}",
            'priority' => 200,
        );
        $return[] = \ElggMenuItem::factory($options);
    }

    if ($entity->canDelete() && $handler) {
        // delete link
        if (elgg_action_exists("$handler/delete")) {
            $action = "action/$handler/delete";
        } else {
            $action = "action/entity/delete";
        }
        $options = array(
            'name' => 'delete',
            'text' => elgg_view_icon('delete'),
            'title' => elgg_echo('delete:this'),
            'href' => "$action?guid={$entity->getGUID()}",
            'confirm' => elgg_echo('deleteconfirm'),
            'priority' => 300,
        );
        $return[] = \ElggMenuItem::factory($options);
    }

    return $return;
}

function _elgg_widget_menu_setup($hook, $type, $return, $params) {

    $widget = $params['entity'];
    /* @var \ElggWidget $widget */
    $show_edit = elgg_extract('show_edit', $params, true);

    $collapse = array(
        'name' => 'collapse',
        'text' => ' ',
        'href' => "#elgg-widget-content-$widget->guid",
        'link_class' => 'elgg-widget-collapse-button',
        'rel' => 'toggle',
        'priority' => 1,
    );
    $return[] = \ElggMenuItem::factory($collapse);

    if ($widget->canEdit()) {
        $delete = array(
            'name' => 'delete',
            'text' => elgg_view_icon('delete-alt'),
            'title' => elgg_echo('widget:delete', array($widget->getTitle())),
            'href' => "action/widgets/delete?widget_guid=$widget->guid",
            'is_action' => true,
            'link_class' => 'elgg-widget-delete-button',
            'id' => "elgg-widget-delete-button-$widget->guid",
            'data-elgg-widget-type' => $widget->handler,
            'priority' => 900,
        );
        $return[] = \ElggMenuItem::factory($delete);

        if ($show_edit) {
            $edit = array(
                'name' => 'settings',
                'text' => elgg_view_icon('settings-alt'),
                'title' => elgg_echo('widget:edit'),
                'href' => "#widget-edit-$widget->guid",
                'link_class' => "elgg-widget-edit-button",
                'rel' => 'toggle',
                'priority' => 800,
            );
            $return[] = \ElggMenuItem::factory($edit);
        }
    }

    return $return;
}

function _elgg_login_menu_setup($hook, $type, $return, $params) {

    if (elgg_get_config('allow_registration')) {
        $return[] = \ElggMenuItem::factory(array(
            'name' => 'register',
            'href' => elgg_get_registration_url(),
            'text' => elgg_echo('register'),
            'link_class' => 'registration_link',
        ));
    }

    $return[] = \ElggMenuItem::factory(array(
        'name' => 'forgotpassword',
        'href' => 'forgotpassword',
        'text' => elgg_echo('user:password:lost'),
        'link_class' => 'forgot_link',
    ));

    return $return;
}


function _elgg_nav_init() {
    elgg_register_plugin_hook_handler('prepare', 'breadcrumbs', 'elgg_prepare_breadcrumbs');

    elgg_register_plugin_hook_handler('prepare', 'menu:site', '_elgg_site_menu_setup');
    elgg_register_plugin_hook_handler('register', 'menu:river', '_elgg_river_menu_setup');
    elgg_register_plugin_hook_handler('register', 'menu:entity', '_elgg_entity_menu_setup');
    elgg_register_plugin_hook_handler('register', 'menu:widget', '_elgg_widget_menu_setup');
    elgg_register_plugin_hook_handler('register', 'menu:login', '_elgg_login_menu_setup');

    elgg_register_plugin_hook_handler('public_pages', 'walled_garden', '_elgg_nav_public_pages');

    elgg_register_menu_item('footer', \ElggMenuItem::factory(array(
        'name' => 'powered',
        'text' => elgg_echo("elgg:powered"),
        'href' => 'http://elgg.org',
        'title' => 'Elgg ' . elgg_get_version(true),
        'section' => 'meta',
    )));

    elgg_register_ajax_view('navigation/menu/user_hover/contents');

    // Using a view extension to ensure that themes that have replaced the item view
    // still load the required AMD modules
    elgg_extend_view('navigation/menu/elements/item', 'navigation/menu/elements/item_deps');
}

function _elgg_nav_public_pages($hook_name, $entity_type, $return_value, $params) {
    if (is_array($return_value)) {
        $return_value[] = 'navigation/menu/user_hover/contents';
    }

    return $return_value;
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', '_elgg_nav_init');
};