ilWebLinkItemsContainer Class Reference

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 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

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 140 of file class.ilWebLinkItemsContainer.php.

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

getItems()

ilWebLinkItemsContainer::getItems

(

)

Returns

ilWebLinkItem[]

Definition at line 135 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 145 of file class.ilWebLinkItemsContainer.php.

References $webr_id.

Referenced by sort().

                               : int
    {
        return $this->webr_id;
    }

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.

References ilContainerSorting\lookupPositions().

Referenced by sort().

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

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.

References ilContainerSortingSettings\_lookupSortMode().

Referenced by sort().

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

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.

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

                          : 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;
    }

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.

References ilArrayUtil\sortArray().

Referenced by sort().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$items

array ilWebLinkItemsContainer::$items

protected

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

Referenced by getItems().

$webr_id

int ilWebLinkItemsContainer::$webr_id

protected

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

Referenced by __construct(), and getWebrId().

---

The documentation for this class was generated from the following file:

• components/ILIAS/WebResource/classes/Item/class.ilWebLinkItemsContainer.php