ObjectsContent.php

Go to the documentation of this file.

<?php

namespace ILIAS\Container\StartObjects\Content;

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\UI\Component\Panel\Sub as SubPanel;
use ilObjUser;
use ilObjectDataCache;
use ilAccessHandler;
use ilObjectDefinition;
use ilLanguage;
use ilCtrl;
use ilContainerStartObjects;
use ilContainerGUI;
use ilFavouritesManager;
use ilCourseLMHistory;
use ilLink;
use ilObjectListGUIPreloader;
use ilObjectListGUI;

class ObjectsContent
{
    protected ilObjUser $user;
    protected ilObjectDataCache $obj_data_cache;
    protected ilAccessHandler $access;
    protected ilObjectDefinition $obj_definition;
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected UIFactory $ui_factory;
    protected UIRenderer $ui_renderer;
    protected ilContainerStartObjects $start_object;
    protected ilContainerGUI $parent_obj;
    protected array $item_list_guis;
    protected bool $enable_desktop;
    protected ilFavouritesManager $fav_manager;

    public function __construct(
        ilContainerGUI $a_parent_obj,
        ilContainerStartObjects $a_start_objects,
        UIFactory $ui_factory,
        UIRenderer $ui_renderer,
        bool $a_enable_desktop = true
    ) {
        global $DIC;

        $this->user = $DIC->user();
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->access = $DIC->access();
        $this->obj_definition = $DIC["objDefinition"];
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $this->lng = $lng;
        $this->lng->loadLanguageModule('rep');
        $this->ctrl = $ilCtrl;

        $this->parent_obj = $a_parent_obj;
        $this->start_object = $a_start_objects;
        $this->enable_desktop = $a_enable_desktop;

        $this->fav_manager = new ilFavouritesManager();
    }

    protected function getData(): array
    {
        $ilUser = $this->user;
        $ilObjDataCache = $this->obj_data_cache;
        $ilAccess = $this->access;

        $lm_continue = new ilCourseLMHistory($this->start_object->getRefId(), $ilUser->getId());
        $continue_data = $lm_continue->getLMHistory();

        $items = [];
        $counter = 0;
        foreach ($this->start_object->getStartObjects() as $start) {
            $obj_id = $ilObjDataCache->lookupObjId((int) $start['item_ref_id']);
            $ref_id = $start['item_ref_id'];
            $type = $ilObjDataCache->lookupType($obj_id);

            if (!$ilAccess->checkAccess("visible", "", $ref_id)) {
                continue;
            }

            // start object status
            if ($this->start_object->isFullfilled($ilUser->getId(), $ref_id)) {
                $accomplished = 'accomplished';
            } else {
                $accomplished = 'not_accomplished';
            }

            // add/remove desktop
            $actions = [];

            if (isset($continue_data[$ref_id])) {
                $url = ilLink::_getLink($ref_id, '', [
                    'obj_id',
                    $continue_data[$ref_id]['lm_page_id']
                ]);
                $actions[$url] = $this->lng->txt('continue_work');
            }

            if ($this->enable_desktop) {
                // add to desktop link
                if (!$this->fav_manager->ifIsFavourite($ilUser->getId(), $ref_id)) {
                    if ($ilAccess->checkAccess('read', '', $ref_id)) {
                        $this->ctrl->setParameter($this->parent_obj, 'item_ref_id', $ref_id);
                        $this->ctrl->setParameter($this->parent_obj, 'item_id', $ref_id);
                        $this->ctrl->setParameter($this->parent_obj, 'type', $type);
                        $url = $this->ctrl->getLinkTarget($this->parent_obj, 'addToDesk');
                        $actions[$url] = $this->lng->txt("rep_add_to_favourites");
                    }
                } else {
                    $this->ctrl->setParameter($this->parent_obj, 'item_ref_id', $ref_id);
                    $this->ctrl->setParameter($this->parent_obj, 'item_id', $ref_id);
                    $this->ctrl->setParameter($this->parent_obj, 'type', $type);
                    $url = $this->ctrl->getLinkTarget($this->parent_obj, 'removeFromDesk');
                    $actions[$url] = $this->lng->txt("rep_remove_from_favourites");
                }
            }

            $default_params = null;
            if ($type === "tst") {
                $default_params["crs_show_result"] = $ref_id;
            }
            /* continue is currently inactive
            if(isset($continue_data[$ref_id]))
            {
                // :TODO: should "continue" be default or 2nd link/action?
                // $this->lng->txt('continue_work')
                $default_params["obj_id"] = $continue_data[$ref_id]['lm_page_id'];
            }
            */

            if ($accomplished === 'accomplished') {
                $icon = "assets/images/standard/icon_ok.svg";
            } else {
                $icon = "assets/images/standard/icon_not_ok.svg";
            }

            $items[] = [
                "nr" => ++$counter,
                "obj_id" => $obj_id,
                "ref_id" => $ref_id,
                "type" => $type,
                "append_default" => $default_params,
                "title" => $ilObjDataCache->lookupTitle($obj_id),
                "description" => $ilObjDataCache->lookupDescription($obj_id),
                "status" => $this->lng->txt('crs_objective_' . $accomplished),
                "status_img" => $icon,
                "actions" => $actions
            ];
        }

        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);
        foreach ($items as $item) {
            $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);
        }
        $preloader->preload();
        unset($preloader);

        return $items;
    }

    protected function getItemListGUI(string $a_type): ?ilObjectListGUI
    {
        $objDefinition = $this->obj_definition;

        if (!isset($this->item_list_guis[$a_type])) {
            $class = $objDefinition->getClassName($a_type);
            // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
            if (!$class) {
                return null;
            }
            // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
            $location = $objDefinition->getLocation($a_type);
            if (!$location) {
                return null;
            }
            $full_class = "ilObj" . $class . "ListGUI";
            $item_list_gui = new $full_class();
            $this->item_list_guis[$a_type] = $item_list_gui;
        } else {
            $item_list_gui = $this->item_list_guis[$a_type];
        }

        $item_list_gui->setDefaultCommandParameters([]);

        return $item_list_gui;
    }

    // Get list gui html
    protected function getListItem(array $a_item): string
    {
        $item_list_gui = $this->getItemListGUI($a_item["type"]);
        if (!$item_list_gui) {
            return "";
        }

        $item_list_gui->setContainerObject($this);
        $item_list_gui->enableCommands(true, true);

        // ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_item);

        // notes, comment currently do not work properly
        $item_list_gui->enableNotes(false);
        $item_list_gui->enableComments(false);
        $item_list_gui->enableTags(false);

        $item_list_gui->enableIcon(true);
        $item_list_gui->enableDelete(false);
        $item_list_gui->enableCut(false);
        $item_list_gui->enableCopy(false);
        $item_list_gui->enableLink(false);
        $item_list_gui->enableInfoScreen(true);
        $item_list_gui->enableSubscribe(false);

        $level = 3;

        if ($level < 3) {
            $item_list_gui->enableDescription(false);
            $item_list_gui->enableProperties(false);
            $item_list_gui->enablePreconditions(false);
        }

        if ($a_item["append_default"]) {
            $item_list_gui->setDefaultCommandParameters($a_item["append_default"]);
        }
        if (is_object($item_list_gui)) {
            return $item_list_gui->getListItemHTML(
                $a_item["ref_id"],
                $a_item["obj_id"],
                $a_item["title"],
                $a_item["description"]
            );
        }
        return "";
    }

    protected function getItemAsSubPanel(array $item): SubPanel
    {
        $status_icon = $this->ui_factory->symbol()->icon()->custom(
            $item['status_img'],
            $item['status']
        );

        $actions = [];
        foreach ($item['actions'] as $url => $caption) {
            $actions[] = $this->ui_factory->button()->shy($caption, $url);
        }

        $secondary_info = $this->ui_factory->listing()->property()->withItems([
            [$this->lng->txt('crs_objective_accomplished'), $status_icon],
            [$this->lng->txt('actions'), $this->ui_renderer->render($actions)]
        ]);

        return $this->ui_factory->panel()->sub(
            '',
            $this->ui_factory->legacy()->content($this->getListItem($item))
        )->withFurtherInformation(
            $this->ui_factory->panel()->secondary()->legacy(
                '',
                $this->ui_factory->legacy()->content($this->ui_renderer->render($secondary_info))
            )
        );
    }

    public function render(): string
    {
        $info = $this->ui_factory->panel()->sub(
            '',
            $this->ui_factory->legacy()->content($this->lng->txt('crs_info_start'))
        );
        $items = [$info];
        foreach ($this->getData() as $datum) {
            $items[] = $this->getItemAsSubPanel($datum);
        }

        $panel = $this->ui_factory->panel()->standard(
            $this->lng->txt('crs_table_start_objects'),
            $items
        );
        return $this->ui_renderer->render($panel);
    }
}