Immutable container class for Web Link items. More...

Inheritance diagram for ilWebLinkItemsContainer:

Collaboration diagram for ilWebLinkItemsContainer:

Public Member Functions
	__construct (int $webr_id, array $items=[])

	sort ()
	Sorts the items in this container according to the settings of this web link object. More...

	getItems ()

	getFirstItem ()

	getWebrId ()

Public Member Functions inherited from ilWebLinkBaseItemsContainer
	__construct (array $items=[])

	getItems ()

	getFirstItem ()

Protected Member Functions
	lookupSortMode (int $webr_id)

	lookupManualPositions (int $webr_id)

	sortArray (array $array, string $sort_by_key, bool $numeric)

Protected Attributes
int	$webr_id

array	$items

Protected Attributes inherited from ilWebLinkBaseItemsContainer
array	$items

Detailed Description

Immutable container class for Web Link items.

Author: Tim Schmitz schmi.nosp@m.tz@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilWebLinkItemsContainer.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkItemsContainer::__construct	(	int	$webr_id,
		array	$items = `[]`
	)

Parameters

int	$webr_id
ilWebLinkItem[]	$items

Definition at line 37 of file class.ilWebLinkItemsContainer.php.

    {
        $this->webr_id = $webr_id;
        parent::__construct($items);
    }

References $items, $webr_id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ getFirstItem()

ilWebLinkItemsContainer::getFirstItem ( )

Reimplemented from ilWebLinkBaseItemsContainer.

Definition at line 140 of file class.ilWebLinkItemsContainer.php.

                                  : ?ilWebLinkItem
    {
        return $this->items[0] ?? null;
    }

◆ getItems()

ilWebLinkItemsContainer::getItems ( )

Returns: ilWebLinkItem[]

Reimplemented from ilWebLinkBaseItemsContainer.

Definition at line 135 of file class.ilWebLinkItemsContainer.php.

                              : array
    {
        return $this->items;
    }

References $items.

Referenced by sort().

Here is the caller graph for this function:

◆ getWebrId()

ilWebLinkItemsContainer::getWebrId ( )

Definition at line 145 of file class.ilWebLinkItemsContainer.php.

                               : int
    {
        return $this->webr_id;
    }

References $webr_id.

Referenced by sort().

Here is the caller graph for this function:

◆ lookupManualPositions()

ilWebLinkItemsContainer::lookupManualPositions ( int $webr_id )

protected

Returns: int[]

Definition at line 116 of file class.ilWebLinkItemsContainer.php.

                                                          : array
    {
        return ilContainerSorting::lookupPositions($webr_id);
    }

References $webr_id, and ilContainerSorting\lookupPositions().

Referenced by sort().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupSortMode()

ilWebLinkItemsContainer::lookupSortMode ( int $webr_id )

protected

Definition at line 108 of file class.ilWebLinkItemsContainer.php.

                                                   : int
    {
        return ilContainerSortingSettings::_lookupSortMode($webr_id);
    }

References $webr_id, and ilContainerSortingSettings\_lookupSortMode().

Referenced by sort().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sort()

ilWebLinkItemsContainer::sort ( )

Sorts the items in this container according to the settings of this web link object.

Definition at line 47 of file class.ilWebLinkItemsContainer.php.

                          : self
    {
        $mode = $this->lookupSortMode($this->getWebrId());
 
        if ($mode == ilContainer::SORT_TITLE) {
            $items_arr = [];
 
            foreach ($this->getItems() as $item) {
                $link_id = $item->getLinkId();
                $items_arr[$link_id]['title'] = $item->getTitle();
                $items_arr[$link_id]['item'] = $item;
            }
 
            $items_arr = $this->sortArray(
                $items_arr,
                'title',
                false
            );
 
            $result = [];
            foreach ($items_arr as $value) {
                $result[] = $value['item'];
            }
            $this->items = $result;
        }
 
        $sorted = $unsorted = [];
        if ($mode == ilContainer::SORT_MANUAL) {
            $pos = $this->lookupManualPositions($this->getWebrId());
            foreach ($this->getItems() as $item) {
                $link_id = $item->getLinkId();
                if (isset($pos[$link_id])) {
                    $sorted[$link_id]['title'] = $item->getTitle();
                    $sorted[$link_id]['position'] = (int) $pos[$link_id];
                    $sorted[$link_id]['item'] = $item;
                } else {
                    $unsorted[$link_id]['title'] = $item->getTitle();
                    $unsorted[$link_id]['item'] = $item;
                }
            }
            $sorted = $this->sortArray(
                $sorted,
                'position',
                true
            );
            $unsorted = $this->sortArray(
                $unsorted,
                'title',
                false
            );
 
            $result = [];
            foreach ($sorted + $unsorted as $value) {
                $result[] = $value['item'];
            }
            $this->items = $result;
        }
 
        return $this;
    }

References getItems(), getWebrId(), ILIAS\Repository\int(), lookupManualPositions(), lookupSortMode(), ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, and sortArray().

Here is the call graph for this function:

◆ sortArray()

ilWebLinkItemsContainer::sortArray	(	array	$array,
		string	$sort_by_key,
		bool	$numeric
	)

protected

Definition at line 121 of file class.ilWebLinkItemsContainer.php.

                                                                                  : array
    {
        return ilArrayUtil::sortArray(
            $array,
            $sort_by_key,
            'asc',
            $numeric,
            true
        );
    }