Page.php

Go to the documentation of this file.

<?php

namespace Elgg\Menus;

use Elgg\Menu\MenuItems;
use Elgg\Menu\PreparedMenu;

class Page {
    
    public static function registerAdminAdminister(\Elgg\Hook $hook) {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'dashboard',
            'text' => elgg_echo('admin:dashboard'),
            'href' => 'admin',
            'priority' => 10,
            'section' => 'administer',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'plugins',
            'text' => elgg_echo('admin:plugins'),
            'href' => 'admin/plugins',
            'priority' => 30,
            'section' => 'administer',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'users',
            'text' => elgg_echo('admin:users'),
            'href' => 'admin/users',
            'priority' => 40,
            'section' => 'administer',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'upgrades',
            'text' => elgg_echo('admin:upgrades'),
            'href' => 'admin/upgrades',
            'priority' => 600,
            'section' => 'administer',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'administer_utilities',
            'text' => elgg_echo('admin:administer_utilities'),
            'href' => false,
            'priority' => 50,
            'section' => 'administer',
            'show_with_empty_children' => false,
        ]);
        
        return $return;
    }
    
    public static function prepareAdminAdministerUsersChildren(\Elgg\Hook $hook): ?PreparedMenu {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return null;
        }
        
        /* @var $result PreparedMenu */
        $result = $hook->getValue();
        
        $administer = $result->getSection('administer');
        /* @var $users \ElggMenuItem */
        $users = $administer->get('users');
        if (!$users instanceof \ElggMenuItem || empty($users->getChildren())) {
            return null;
        }
        
        $children = $users->getChildren();
        
        $selected = $users->getSelected();
        array_unshift($children, \ElggMenuItem::factory([
            'name' => 'users:all',
            'text' => elgg_echo('all'),
            'href' => 'admin/users',
            'priority' => 1,
            'selected' => $selected,
        ]));
        $users->setChildren($children);
        
        if ($selected) {
            $users->addItemClass('elgg-has-selected-child');
            $users->addItemClass('elgg-state-selected');
        }
        
        $users->setHref(false);
        
        return $result;
    }
    
    public static function registerAdminConfigure(\Elgg\Hook $hook) {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'settings:basic',
            'text' => elgg_echo('admin:site_settings'),
            'href' => 'admin/site_settings',
            'priority' => 10,
            'section' => 'configure',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'settings:icons',
            'text' => elgg_echo('admin:site_icons'),
            'href' => 'admin/site_icons',
            'priority' => 20,
            'section' => 'configure',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'security',
            'text' => elgg_echo('admin:security'),
            'href' => 'admin/security',
            'priority' => 30,
            'section' => 'configure',
        ]);
        
        // Utilities
        $return[] = \ElggMenuItem::factory([
            'name' => 'configure_utilities',
            'text' => elgg_echo('admin:configure_utilities'),
            'href' => false,
            'priority' => 600,
            'section' => 'configure',
        ]);
        $return[] = \ElggMenuItem::factory([
            'name' => 'configure_utilities:maintenance',
            'text' => elgg_echo('admin:configure_utilities:maintenance'),
            'href' => 'admin/configure_utilities/maintenance',
            'section' => 'configure',
            'parent_name' => 'configure_utilities',
        ]);
        $return[] = \ElggMenuItem::factory([
            'name' => 'configure_utilities:menu_items',
            'text' => elgg_echo('admin:configure_utilities:menu_items'),
            'href' => 'admin/configure_utilities/menu_items',
            'section' => 'configure',
            'parent_name' => 'configure_utilities',
        ]);
        $return[] = \ElggMenuItem::factory([
            'name' => 'configure_utilities:robots',
            'text' => elgg_echo('admin:configure_utilities:robots'),
            'href' => 'admin/configure_utilities/robots',
            'section' => 'configure',
            'parent_name' => 'configure_utilities',
        ]);
        
        return $return;
    }
    
    public static function registerAdminDefaultWidgets(\Elgg\Hook $hook) {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return;
        }
        
        if (empty(elgg_trigger_plugin_hook('get_list', 'default_widgets', null, []))) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'default_widgets',
            'text' => elgg_echo('admin:configure_utilities:default_widgets'),
            'href' => 'admin/configure_utilities/default_widgets',
            'section' => 'configure',
            'parent_name' => 'configure_utilities',
        ]);

        return $return;
    }
    
    public static function registerAdminInformation(\Elgg\Hook $hook) {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'server',
            'text' => elgg_echo('admin:server'),
            'href' => 'admin/server',
            'section' => 'information',
            'priority' => 50,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'information:security',
            'text' => elgg_echo('admin:security'),
            'href' => 'admin/security/information',
            'section' => 'information',
            'priority' => 60,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'information:performance',
            'text' => elgg_echo('admin:performance'),
            'href' => 'admin/performance',
            'section' => 'information',
            'priority' => 70,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'statistics',
            'text' => elgg_echo('admin:statistics'),
            'href' => 'admin/statistics',
            'section' => 'information',
            'priority' => 80,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'cron',
            'text' => elgg_echo('admin:cron'),
            'href' => 'admin/cron',
            'section' => 'information',
            'priority' => 90,
        ]);
        
        return $return;
    }
    
    public static function registerAdminPluginSettings(\Elgg\Hook $hook) {
        if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
            return;
        }
        
        // plugin settings
        $active_plugins = elgg_get_plugins('active');
        if (empty($active_plugins)) {
            // nothing added because no items
            return;
        }
        
        $plugins_with_settings = [];
        
        foreach ($active_plugins as $plugin) {
            $plugin_id = $plugin->getID();
            
            if (!elgg_view_exists("plugins/{$plugin_id}/settings") ) {
                continue;
            }
            $plugin_name = $plugin->getDisplayName();
            $plugins_with_settings[strtolower($plugin_name)] = [
                'name' => "plugin:settings:{$plugin_id}",
                'href' => elgg_generate_url('admin:plugin_settings', [
                    'plugin_id' => $plugin_id,
                ]),
                'text' => $plugin_name,
                'parent_name' => 'plugin_settings',
                'section' => 'configure',
            ];
        }
        
        if (empty($plugins_with_settings)) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'plugin_settings',
            'text' => elgg_echo('admin:plugin_settings'),
            'href' => false,
            'section' => 'configure',
        ]);
        
        ksort($plugins_with_settings);
        $priority = 0;
        foreach ($plugins_with_settings as $plugin_item) {
            $priority += 10;
            $plugin_item['priority'] = $priority;
            $return[] = \ElggMenuItem::factory($plugin_item);
        }
        
        return $return;
    }
    
    public static function registerUserSettings(\Elgg\Hook $hook) {
        $user = elgg_get_page_owner_entity();
        if (!$user instanceof \ElggUser || !elgg_in_context('settings') || !$user->canEdit()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => '1_account',
            'text' => elgg_echo('usersettings:user:opt:linktext'),
            'href' => elgg_generate_url('settings:account', [
                'username' => $user->username,
            ]),
            'section' => 'configure',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => '1_notifications',
            'text' => elgg_echo('usersettings:notifications:menu:page'),
            'href' => elgg_generate_url('settings:notifications', [
                'username' => $user->username,
            ]),
            'section' => 'configure',
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => '1_statistics',
            'text' => elgg_echo('usersettings:statistics:opt:linktext'),
            'href' => elgg_generate_url('settings:statistics', [
                'username' => $user->username,
            ]),
            'section' => 'configure',
        ]);
        
        return $return;
    }
    
    public static function registerUserSettingsPlugins(\Elgg\Hook $hook) {
        $user = elgg_get_page_owner_entity();
        if (!$user instanceof \ElggUser || !elgg_in_context('settings') || !$user->canEdit()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => '1_plugins',
            'text' => elgg_echo('usersettings:plugins:opt:linktext'),
            'href' => false,
            'section' => 'configure',
            'show_with_empty_children' => false,
        ]);
        
        $active_plugins = elgg_get_plugins();
        foreach ($active_plugins as $plugin) {
            $plugin_id = $plugin->getID();
            if (!elgg_view_exists("plugins/{$plugin_id}/usersettings")) {
                continue;
            }
            
            $title = $plugin->getDisplayName();
            if (elgg_language_key_exists("{$plugin_id}:usersettings:title")) {
                $title = elgg_echo("{$plugin_id}:usersettings:title");
            }
            
            $return[] = \ElggMenuItem::factory([
                'name' => $plugin_id,
                'text' => $title,
                'href' => elgg_generate_url('settings:tools', [
                    'username' => $user->username,
                    'plugin_id' => $plugin_id,
                ]),
                'parent_name' => '1_plugins',
                'section' => 'configure',
            ]);
        }
        
        return $return;
    }
    
    public static function registerAvatarEdit(\Elgg\Hook $hook) {
        $user = $hook->getParam('entity', elgg_get_page_owner_entity());
        if (!$user instanceof \ElggUser || !$user->canEdit() || !elgg_in_context('settings')) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $hook->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'edit_avatar',
            'text' => elgg_echo('avatar:edit'),
            'href' => elgg_generate_entity_url($user, 'edit', 'avatar'),
            'section' => '1_profile',
        ]);
        
        return $return;
    }
}