Filter.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Menus;
 
use Elgg\Menu\MenuItems;
 
class Filter {
    
    public static function registerAdminUpgrades(\Elgg\Event $event) {
        if (!elgg_is_admin_logged_in()) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $event->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'pending',
            'text' => elgg_echo('admin:upgrades:menu:pending'),
            'href' => 'admin/upgrades',
            'priority' => 100,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'completed',
            'text' => elgg_echo('admin:upgrades:menu:completed'),
            'href' => 'admin/upgrades/finished',
            'priority' => 200,
        ]);
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'db',
            'text' => elgg_echo('admin:upgrades:menu:db'),
            'href' => 'admin/upgrades/db',
            'priority' => 300,
        ]);
        
        return $return;
    }
    
    public static function registerNotificationSettings(\Elgg\Event $event) {
        $page_owner = elgg_get_page_owner_entity();
        if (!$page_owner instanceof \ElggUser || !$page_owner->canEdit()) {
            return;
        }
        
        /* @var $result MenuItems */
        $result = $event->getValue();
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'settings',
            'text' => elgg_echo('usersettings:notifications:menu:filter:settings'),
            'href' => elgg_generate_url('settings:notifications', [
                'username' => $page_owner->username,
            ]),
            'priority' => 100,
        ]);
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'users',
            'text' => elgg_echo('collection:user:user'),
            'href' => elgg_generate_url('settings:notifications:users', [
                'username' => $page_owner->username,
            ]),
            'priority' => 200,
        ]);
    }
 
    public static function registerAllFilterTab(\Elgg\Event $event): ?MenuItems {
        if (elgg_get_page_owner_guid() && (elgg_get_page_owner_guid() !== elgg_get_logged_in_user_guid())) {
            return null;
        }
        
        $entity_type = $event->getParam('entity_type', '');
        $entity_subtype = $event->getParam('entity_subtype', '');
        if (empty($entity_type) || empty($entity_subtype)) {
            $route_name = elgg_get_current_route_name();
            if (!empty($route_name)) {
                // assume route name as '<purpose>:<entity type>:<entity subtype>:<sub>'
                // eg collection:object:blog:owner or view:group:group
                // @see http://learn.elgg.org/en/stable/guides/routing.html#routes-names
                $route_parts = explode(':', $route_name);
                $entity_type = elgg_extract(1, $route_parts, '');
                $entity_subtype = elgg_extract(2, $route_parts, '');
            }
        }
 
        $all_link = $event->getParam('all_link');
        if (empty($all_link)) {
            if (elgg_route_exists("collection:{$entity_type}:{$entity_subtype}:all")) {
                $all_link = elgg_generate_url("collection:{$entity_type}:{$entity_subtype}:all");
            } elseif (elgg_route_exists("collection:{$entity_type}:all")) {
                $all_link = elgg_generate_url("collection:{$entity_type}:all");
            }
        } else {
            elgg_deprecated_notice("Using the 'all_link' parameter is deprecated. Use correct route names instead.", '7.1');
        }
 
        if (empty($all_link)) {
            return null;
        }
 
        /* @var $result MenuItems */
        $result = $event->getValue();
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'all',
            'text' => elgg_echo('all'),
            'href' => $all_link,
            'priority' => 200,
        ]);
        
        return $result;
    }
    
    public static function registerMineFilterTab(\Elgg\Event $event): ?MenuItems {
        $user = elgg_get_logged_in_user_entity();
        if (!$user instanceof \ElggUser) {
            return null;
        }
        
        if (elgg_get_page_owner_guid() && (elgg_get_page_owner_guid() !== $user->guid)) {
            return null;
        }
        
        $entity_type = $event->getParam('entity_type', '');
        $entity_subtype = $event->getParam('entity_subtype', '');
        if (empty($entity_type) || empty($entity_subtype)) {
            $route_name = elgg_get_current_route_name();
            if (!empty($route_name)) {
                // assume route name as '<purpose>:<entity type>:<entity subtype>:<sub>'
                // eg collection:object:blog:owner or view:group:group
                // @see http://learn.elgg.org/en/stable/guides/routing.html#routes-names
                $route_parts = explode(':', $route_name);
                $entity_type = elgg_extract(1, $route_parts, '');
                $entity_subtype = elgg_extract(2, $route_parts, '');
            }
        }
 
        $mine_link = $event->getParam('mine_link');
        if (empty($mine_link)) {
            if (elgg_route_exists("collection:{$entity_type}:{$entity_subtype}:owner")) {
                $mine_link = elgg_generate_url("collection:{$entity_type}:{$entity_subtype}:owner", [
                    'username' => $user->username,
                ]);
            } elseif (elgg_route_exists("collection:{$entity_type}:owner")) {
                $mine_link = elgg_generate_url("collection:{$entity_type}:owner", [
                    'username' => $user->username,
                ]);
            }
        } else {
            elgg_deprecated_notice("Using the 'mine_link' parameter is deprecated. Use correct route names instead.", '7.1');
        }
 
        if (empty($mine_link)) {
            return null;
        }
 
        /* @var $result MenuItems */
        $result = $event->getValue();
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'mine',
            'text' => elgg_echo('mine'),
            'href' => $mine_link,
            'priority' => 300,
        ]);
        
        return $result;
    }
    
    public static function registerAdminUsers(\Elgg\Event $event): MenuItems {
        /* @var $result MenuItems */
        $result = $event->getValue();
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'all',
            'text' => elgg_echo('all'),
            'href' => 'admin/users',
            'priority' => 100,
        ]);
        $result[] = \ElggMenuItem::factory([
            'name' => 'online',
            'text' => elgg_echo('admin:users:online'),
            'href' => 'admin/users/online',
            'priority' => 200,
        ]);
        $result[] = \ElggMenuItem::factory([
            'name' => 'admins',
            'text' => elgg_echo('admin:users:admins'),
            'href' => 'admin/users/admins',
            'priority' => 300,
        ]);
        $result[] = \ElggMenuItem::factory([
            'name' => 'banned',
            'text' => elgg_echo('admin:users:banned'),
            'href' => 'admin/users/banned',
            'priority' => 400,
        ]);
        $result[] = \ElggMenuItem::factory([
            'name' => 'unvalidated',
            'text' => elgg_echo('admin:users:unvalidated'),
            'href' => 'admin/users/unvalidated',
            'priority' => 500,
        ]);
        $result[] = \ElggMenuItem::factory([
            'name' => 'inactive',
            'text' => elgg_echo('admin:users:inactive'),
            'href' => 'admin/users/inactive',
            'priority' => 600,
        ]);
        
        $result[] = \ElggMenuItem::factory([
            'name' => 'search',
            'icon' => 'search',
            'text' => elgg_echo('search'),
            'href' => false,
            'class' => 'elgg-toggle',
            'data-toggle-selector' => '.elgg-form-admin-users-search',
            'priority' => 9999,
        ]);
        
        return $result;
    }
    
    public static function registerAvatarEdit(\Elgg\Event $event) {
        $user = $event->getParam('entity', elgg_get_page_owner_entity());
        if (!$user instanceof \ElggUser) {
            return;
        }
        
        /* @var $return MenuItems */
        $return = $event->getValue();
        
        $return[] = \ElggMenuItem::factory([
            'name' => 'edit_avatar',
            'text' => elgg_echo('avatar:edit'),
            'href' => elgg_generate_entity_url($user, 'edit', 'avatar'),
        ]);
        
        return $return;
    }
}