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

Collaboration diagram for ilLSItemsDB:

Public Member Functions
	__construct (ilTree $tree, ilContainerSorting $container_sorting, ilLSPostConditionDB $post_conditions_db, LSItemOnlineStatus $ls_item_online_status)
	getLSItems (int $ref_id)
	storeItems (array $ls_items)
	Use this to apply settings made in ContentGUI. More...

Protected Member Functions
	getIconPathForType (string $type)
	getConditionsForChildren (array $children)
	Collect all conditions at once. More...
	storeItemsOrder (array $ls_items)
	storeOnlineStatus (array $ls_items)
	storePostconditions (array $ls_items)
	getObjectFor (int $ref_id)

Protected Attributes
ilTree	$tree
ilContainerSorting	$container_sorting
ilLSPostConditionDB	$post_conditions_db
LSItemOnlineStatus	$ls_item_online_status

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

Definition at line 24 of file ilLSItemsDB.php.

Constructor & Destructor Documentation

__construct()

ilLSItemsDB::__construct	(	ilTree	$tree,
		ilContainerSorting	$container_sorting,
		ilLSPostConditionDB	$post_conditions_db,
		LSItemOnlineStatus	$ls_item_online_status
	)

Definition at line 31 of file ilLSItemsDB.php.

References $container_sorting, $ls_item_online_status, $post_conditions_db, and $tree.

      {
        $this->tree = $tree;
        $this->container_sorting = $container_sorting;
        $this->post_conditions_db = $post_conditions_db;
        $this->ls_item_online_status = $ls_item_online_status;
    }

Member Function Documentation

getConditionsForChildren()

ilLSItemsDB::getConditionsForChildren ( array  $children )

protected

Collect all conditions at once.

Returns

array <int,ilLSPostCondition>

Definition at line 84 of file ilLSItemsDB.php.

References $i.

Referenced by getLSItems().

                                                                : array
    {
        $ref_ids = array_map(
            fn ($i) => (int) $i['child'],
            $children
        );

        $conditions = [];
        foreach ($this->post_conditions_db->select($ref_ids) as $condition) {
            $conditions[$condition->getRefId()] = $condition;
        }

        return $conditions;
    }

Here is the caller graph for this function:

getIconPathForType()

ilLSItemsDB::getIconPathForType ( string  $type )

protected

Definition at line 75 of file ilLSItemsDB.php.

References ilObject\_getIcon().

Referenced by getLSItems().

                                                       : string
    {
        return ilObject2::_getIcon(0, "big", $type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLSItems()

ilLSItemsDB::getLSItems

(

int

$ref_id

)

Returns

LSItem[]

Definition at line 46 of file ilLSItemsDB.php.

References $ref_id, getConditionsForChildren(), getIconPathForType(), ILIAS\Repository\int(), and ilContainer\SORT_MANUAL.

                                           : array
    {
        $children = $this->tree->getChilds($ref_id);

        $sorting_settings = $this->container_sorting->getSortingSettings();
        $sorting_settings->setSortMode(ilContainer::SORT_MANUAL);
        $sorted = $this->container_sorting->sortItems(['lsitems' => $children]);
        $children = $sorted['lsitems'];

        $conditions = $this->getConditionsForChildren($children);

        $items = [];
        foreach ($children as $position => $child) {
            $ref_id = (int) $child['child'];
            $items[] = new LSItem(
                $child['type'],
                $child['title'],
                $child['description'] ?? "",
                $this->getIconPathForType($child['type']),
                $this->ls_item_online_status->getOnlineStatus($ref_id),
                $position,
                $conditions[$ref_id],
                $ref_id
            );
        }

        return $items;
    }

Here is the call graph for this function:

getObjectFor()

ilLSItemsDB::getObjectFor ( int  $ref_id )

protected

Definition at line 139 of file ilLSItemsDB.php.

References ilObjectFactory\getInstanceByRefId().

                                                : \ilObject
    {
        return ilObjectFactory::getInstanceByRefId($ref_id);
    }

Here is the call graph for this function:

storeItems()

ilLSItemsDB::storeItems

(

array

$ls_items

)

Use this to apply settings made in ContentGUI.

Definition at line 130 of file ilLSItemsDB.php.

References storeItemsOrder(), storeOnlineStatus(), and storePostconditions().

                                               : void
    {
        $this->storeOnlineStatus($ls_items);
        $this->storeItemsOrder($ls_items);
        $this->storePostconditions($ls_items);
    }

Here is the call graph for this function:

storeItemsOrder()

ilLSItemsDB::storeItemsOrder ( array  $ls_items )

protected

Definition at line 99 of file ilLSItemsDB.php.

Referenced by storeItems().

                                                       : void
    {
        $type_positions = [];
        foreach ($ls_items as $item) {
            $type_positions[$item->getRefId()] = $item->getOrderNumber();
        }
        $this->container_sorting->savePost($type_positions);
    }

Here is the caller graph for this function:

storeOnlineStatus()

ilLSItemsDB::storeOnlineStatus ( array  $ls_items )

protected

Definition at line 108 of file ilLSItemsDB.php.

Referenced by storeItems().

                                                         : void
    {
        foreach ($ls_items as $item) {
            $this->ls_item_online_status->setOnlineStatus(
                $item->getRefId(),
                $item->isOnline()
            );
        }
    }

Here is the caller graph for this function:

storePostconditions()

ilLSItemsDB::storePostconditions ( array  $ls_items )

protected

Definition at line 118 of file ilLSItemsDB.php.

Referenced by storeItems().

                                                           : void
    {
        $conditions = [];
        foreach ($ls_items as $item) {
            $conditions[] = $item->getPostCondition();
        }
        $this->post_conditions_db->upsert($conditions);
    }

Here is the caller graph for this function:

Field Documentation

$container_sorting

ilContainerSorting ilLSItemsDB::$container_sorting

protected

Definition at line 27 of file ilLSItemsDB.php.

Referenced by __construct().

$ls_item_online_status

LSItemOnlineStatus ilLSItemsDB::$ls_item_online_status

protected

Definition at line 29 of file ilLSItemsDB.php.

Referenced by __construct().

$post_conditions_db

ilLSPostConditionDB ilLSItemsDB::$post_conditions_db

protected

Definition at line 28 of file ilLSItemsDB.php.

Referenced by __construct().

$tree

ilTree ilLSItemsDB::$tree

protected

Definition at line 26 of file ilLSItemsDB.php.

Referenced by __construct().

---

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

• Modules/LearningSequence/classes/LSItems/ilLSItemsDB.php