ilLSItemsDB.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLSItemsDB
{
    protected ilTree $tree;
    protected ilContainerSorting $container_sorting;
    protected ilLSPostConditionDB $post_conditions_db;
    protected LSItemOnlineStatus $ls_item_online_status;

    public function __construct(
        ilTree $tree,
        ilContainerSorting $container_sorting,
        ilLSPostConditionDB $post_conditions_db,
        LSItemOnlineStatus $ls_item_online_status
    ) {
        $this->tree = $tree;
        $this->container_sorting = $container_sorting;
        $this->post_conditions_db = $post_conditions_db;
        $this->ls_item_online_status = $ls_item_online_status;
    }

    public function getLSItems(int $ref_id): 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'];
            $obj_id = (int) $child['obj_id'];
            $lp_mode = $this->getCurrentLPMode($obj_id);

            $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,
                $lp_mode
            );
        }

        return $items;
    }

    protected function getCurrentLPMode(int $obj_id): int
    {
        $obj_lp = ilObjectLP::getInstance($obj_id);
        return $obj_lp->getCurrentMode();
    }

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

    protected function getConditionsForChildren(array $children): 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;
    }

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

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

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

    public function storeItems(array $ls_items): void
    {
        $this->storeOnlineStatus($ls_items);
        $this->storeItemsOrder($ls_items);
        $this->storePostconditions($ls_items);
    }

    // The typehint on ilObject is intentional, we expect this to return some object
    // or need to error instead.
    protected function getObjectFor(int $ref_id): \ilObject
    {
        return ilObjectFactory::getInstanceByRefId($ref_id);
    }
}