list.php

Go to the documentation of this file.

<?php
$items = elgg_extract('items', $vars);

if (!$items) {
    echo elgg_view('page/components/no_results', $vars);
    echo elgg_view('page/components/list/out_of_bounds', $vars);
    return;
}

if (!is_array($items) || count($items) == 0) {
    return;
}

$position = elgg_extract('position', $vars, 'after');
$pagination_behaviour = elgg_extract('pagination_behaviour', $vars, elgg_get_config('pagination_behaviour'));
$pagination = (bool) elgg_extract('pagination', $vars, true);
if (elgg_in_context('widget')) {
    // widgets do not show pagination
    $pagination = false;
}

$pagination_before_options = (array) elgg_extract('pagination_before_options', $vars, []);
unset($vars['pagination_before_options']);
$pagination_after_options = (array) elgg_extract('pagination_after_options', $vars, []);
unset($vars['pagination_after_options']);

if (in_array($pagination_behaviour, ['ajax-append', 'ajax-append-auto'])) {
    $position = 'both';
    $vars['position'] = $position;

    // set before options
    $pagination_before_options['pagination_show_numbers'] = false;
    $pagination_before_options['pagination_show_next'] = false;
    $pagination_before_options['pagination_show_previous'] = true;
    $pagination_before_options['pagination_previous_text'] = elgg_echo('ajax:pagination:load_more');
    
    // set after options
    $pagination_after_options['pagination_show_numbers'] = false;
    $pagination_after_options['pagination_show_next'] = true;
    $pagination_after_options['pagination_show_previous'] = false;
    $pagination_after_options['pagination_next_text'] = elgg_echo('ajax:pagination:load_more');
}

$list_classes = elgg_extract_class($vars, 'elgg-list', 'list_class');

$list_item_view = elgg_extract('list_item_view', $vars);
if (empty($list_item_view) || !elgg_view_exists($list_item_view)) {
    $list_item_view = 'page/components/list/item';
}

$index = 0;
$list_items = '';
foreach ($items as $item) {
    $item_view_vars = $vars;
    $item_view_vars['list_item_index'] = $index;
    $item_view = elgg_view_list_item($item, $item_view_vars);
    if (empty($item_view)) {
        continue;
    }

    $list_item_vars = $vars;
    $list_item_vars['content'] = $item_view;
    $list_item_vars['item'] = $item;
    
    $list_items .= elgg_view($list_item_view, $list_item_vars);
    
    $index++;
}

$result = '';
if ($pagination && ($position == 'before' || $position == 'both')) {
    $pagination_options = array_merge($vars, $pagination_before_options);
    $pagination_options['position'] = 'before';
    
    $result .= elgg_view('navigation/pagination', $pagination_options);
}

if (empty($list_items)) {
    // there are scenarios where item views do not output html. In those cases show the no results info
    $result .= elgg_view('page/components/no_results', $vars);
} else {
    $result .= elgg_format_element('ul', ['class' => $list_classes], $list_items);
}

if ($pagination && ($position == 'after' || $position == 'both')) {
    $pagination_options = array_merge($vars, $pagination_after_options);
    $pagination_options['position'] = 'after';
    
    $result .= elgg_view('navigation/pagination', $pagination_options);
}

$limit = elgg_extract('limit', $vars);
if (!$pagination && $limit !== false && !empty($items) && count($items) >= $limit) {
    $result .= elgg_view('page/components/list/widget_more', $vars);
}

$base_url = elgg_extract('base_url', $vars);
if (!empty($base_url)) {
    // strip offset and limit from base url as they always change when navigating and therefore should not be part of base url
    $base_url = elgg_http_add_url_query_elements($base_url, ['offset' => null, 'limit' => null]);
}

// make a unique ID for AJAX pagination
$id = null;
if ($pagination) {
    $id = 'list-container-' . elgg_build_hmac([
        $list_classes,
        $list_item_view,
        elgg_extract('item_view', $vars),
        elgg_extract('type', $vars),
        elgg_extract('subtype', $vars),
        elgg_extract('offset_key', $vars),
        elgg_extract('pagination_class', $vars),
        $base_url,
    ])->getToken();
}

$container_classes = ['elgg-list-container'];
if ($pagination && ($pagination_behaviour !== 'navigate')) {
    $container_classes[] = "elgg-list-container-{$pagination_behaviour}";
    if ($pagination_behaviour === 'ajax-append-auto') {
        // make sure default logic for ajax append works
        $container_classes[] = 'elgg-list-container-ajax-append';
    }

    if (elgg_view_exists("page/components/list/{$pagination_behaviour}.mjs")) {
        elgg_import_esm("page/components/list/{$pagination_behaviour}");
    }
}

echo elgg_format_element('div', ['class' => $container_classes, 'id' => $id], $result);