This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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 Attributes
int	$webr_id

array	$items

Protected Attributes inherited from ilWebLinkBaseItemsContainer
array	$items

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getFirstItem()

ilWebLinkItemsContainer::getFirstItem ( )

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

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

◆ getItems()

ilWebLinkItemsContainer::getItems ( )

Returns: ilWebLinkItem[]

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

References $items.

Referenced by sort().

                               : array
     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ getWebrId()

ilWebLinkItemsContainer::getWebrId ( )

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

References $webr_id.

Referenced by sort().

                                : int
     {
         return $this->webr_id;
     }

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.

References ilContainerSortingSettings\_lookupSortMode(), getItems(), getWebrId(), ILIAS\Repository\int(), ilContainerSorting\lookupPositions(), ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, and ilArrayUtil\sortArray().

                           : self
     {
         $mode = ilContainerSortingSettings::_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 = ilArrayUtil::sortArray(
                 $items_arr,
                 'title',
                 'asc',
                 false,
                 true
             );
 
             $result = [];
             foreach ($items_arr as $value) {
                 $result[] = $value['item'];
             }
             $this->items = $result;
         }
 
         $sorted = $unsorted = [];
         if ($mode == ilContainer::SORT_MANUAL) {
             $pos = ilContainerSorting::lookupPositions(
                 $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 = ilArrayUtil::sortArray(
                 $sorted,
                 'position',
                 'asc',
                 true,
                 true
             );
             $unsorted = ilArrayUtil::sortArray(
                 $unsorted,
                 'title',
                 'asc',
                 false,
                 true
             );
 
             $result = [];
             foreach ($sorted + $unsorted as $value) {
                 $result[] = $value['item'];
             }
             $this->items = $result;
         }
 
         return $this;
     }