class.ilSessionMaterialsTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSessionMaterialsTableGUI extends ilTable2GUI
{
    protected ILIAS\UI\Factory $ui;
    protected ILIAS\UI\Renderer $renderer;
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected ilTree $tree;
    protected ilObjectDefinition $objDefinition;
    protected int $container_ref_id = 0;
    protected array $material_items = [];
    protected array $filter = [];
    protected int $parent_ref_id = 0;
    protected int $parent_object_id = 0;

    public function __construct(object $a_parent_obj, string $a_parent_cmd)
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->objDefinition = $DIC['objDefinition'];
        $this->ui = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();

        $this->setId("sess_materials_" . $a_parent_obj->getCurrentObject()->getId());

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->parent_ref_id = $this->tree->getParentId($a_parent_obj->getCurrentObject()->getRefId());
        $this->parent_object_id = $a_parent_obj->getCurrentObject()->getId();

        $this->setRowTemplate("tpl.session_materials_row.html", "components/ILIAS/Session");
        $this->setFormName('materials');
        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));

        $this->addColumn("", "f", "1");
        $this->addColumn($this->lng->txt("crs_materials"), "title", "90%");
        $this->addColumn($this->lng->txt("sess_is_assigned"), "active", "5");
        $this->setSelectAllCheckbox('items');

        $this->setFilterCommand("applyFilter");
        $this->setResetCommand("resetFilter");
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setDefaultOrderDirection('desc');
        $this->setDefaultOrderField('active');

        $this->initFilter();
        $this->determineOffsetAndOrder(true);
        $this->lng->loadLanguageModule('sess');
    }

    public function setMaterialItems(array $a_set): void
    {
        $this->material_items = $a_set;
    }

    public function getMaterialItems(): array
    {
        return $this->material_items;
    }

    public function setContainerRefId(int $a_set): void
    {
        $this->container_ref_id = $a_set;
    }

    public function getContainerRefId(): int
    {
        return $this->container_ref_id;
    }

    public function getDataFromDb(): array
    {
        $tree = $this->tree;
        $objDefinition = $this->objDefinition;

        $materials = [];

        $already_assigned_ref_ids = [];
        foreach ($this->getMaterialItems() as $ref_id) {
            $already_assigned_ref_ids[] = $ref_id;
            $node = $tree->getNodeData($ref_id);
            $node['active'] = 1;
            $materials[] = $tree->getNodeData($ref_id);
        }

        foreach ($tree->getSubTree($tree->getNodeData($this->parent_ref_id)) as $node) {
            if (in_array($node['ref_id'], $already_assigned_ref_ids)) {
                continue;
            }

            // No side blocks here
            if ($node['child'] == $this->parent_ref_id ||
                $objDefinition->isSideBlock($node['type']) ||
                in_array($node['type'], array('sess', 'itgr', 'rolf'))) {
                continue;
            }

            $node['active'] = 0;
            $materials[] = $node;
        }

        // stable sort by assignment
        $materials = ilArrayUtil::stableSortArray($materials, 'title', 'asc');
        $materials = ilArrayUtil::stableSortArray($materials, $this->getOrderField(), $this->getOrderDirection());
        if (!empty($this->filter)) {
            $materials = $this->filterData($materials);
        }
        return $materials;
    }

    public function filterData(array $a_data): array
    {
        $data_filtered = $a_data;

        //Filter by title
        if (isset($this->filter["title"]) && $this->filter['title'] !== '') {
            foreach ($data_filtered as $key => $material) {
                $title = $material["title"];
                if (stripos($title, $this->filter["title"]) === false) {
                    unset($data_filtered[$key]);
                }
            }
        }

        //Filter by obj type
        if (isset($this->filter['type']) && $this->filter['type'] !== '') {
            foreach ($data_filtered as $key => $material) {
                $type = $material["type"];
                //types can be: file, exc
                if ($type != $this->filter["type"]) {
                    unset($data_filtered[$key]);
                }
            }
        }

        //Filter by status
        if (isset($this->filter["status"]) && $this->filter['status'] !== '') {
            //items_ref = materials already assigned.
            $assigned_items = new ilEventItems($this->parent_object_id);
            $assigned_items = $assigned_items->getItems();

            if ($this->filter["status"] == "assigned") {
                foreach ($data_filtered as $key => $material) {
                    if (!in_array($material["ref_id"], $assigned_items)) {
                        unset($data_filtered[$key]);
                    }
                }
            } elseif ($this->filter["status"] == "notassigned") {
                foreach ($data_filtered as $key => $material) {
                    if (in_array($material["ref_id"], $assigned_items)) {
                        unset($data_filtered[$key]);
                    }
                }
            }
        }

        return $data_filtered;
    }

    public function setMaterials(array $a_materials): void
    {
        $this->setData($a_materials);
    }

    protected function fillRow(array $a_set): void
    {
        $this->tpl->setVariable('TYPE_IMG', ilObject::_getIcon(0, 'tiny', $a_set['type']));
        $this->tpl->setVariable('IMG_ALT', $this->lng->txt('obj_' . $a_set['type']));

        $this->tpl->setVariable("VAL_POSTNAME", "items");
        $this->tpl->setVariable("VAL_ID", $a_set['ref_id']);

        $this->tpl->setVariable("COLL_TITLE", $a_set['title']);

        if (strlen((string) $a_set['description'])) {
            $this->tpl->setVariable("COLL_DESC", (string) $a_set['description']);
        }
        if (in_array($a_set['ref_id'], $this->getMaterialItems())) {
            $ass_glyph = $this->ui->symbol()->icon()->custom(
                ilUtil::getImagePath("standard/icon_ok.svg"),
                $this->lng->txt("assigned")
            );
            $this->tpl->setVariable("ASSIGNED_IMG_OK", $this->renderer->render($ass_glyph));
        }

        $path = new ilPathGUI();
        $path->enableDisplayCut(false);
        $path->enableTextOnly(false);
        $path->enableHideLeaf(false);
        $this->tpl->setVariable("COLL_PATH", $path->getPath($this->getContainerRefId(), (int) $a_set['ref_id']));
    }

    public function typesAvailable(): array
    {
        $items = $this->getDataFromDb();

        $all_types = [];
        foreach ($items as $item) {
            $all_types[] = $item["type"];
        }
        return array_values(array_unique($all_types));
    }

    public function initFilter(): void
    {
        // title
        $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
        $ti->setMaxLength(64);
        $ti->setSize(20);
        $this->addFilterItem($ti);
        $ti->readFromSession(); // get currenty value from session (always after addFilterItem())
        $this->filter["title"] = $ti->getValue();

        // types
        //todo remove banned types if necessary.
        $filter_types = $this->typesAvailable();
        $types = [];
        $types[0] = $this->lng->txt('sess_filter_all_types');
        foreach ($filter_types as $type) {
            $types["$type"] = $this->lng->txt("obj_" . $type);
        }

        $select = new ilSelectInputGUI($this->lng->txt("type"), "type");
        $select->setOptions($types);
        $this->addFilterItem($select);
        $select->readFromSession();
        $this->filter["type"] = $select->getValue();

        // status
        $status = [];
        $status[0] = "-";
        $status["notassigned"] = $this->lng->txt("sess_filter_not_assigned");
        $status["assigned"] = $this->lng->txt("assigned");

        $select_status = new ilSelectInputGUI($this->lng->txt("assigned"), "status");
        $select_status->setOptions($status);
        $this->addFilterItem($select_status);
        $select_status->readFromSession();
        $this->filter['status'] = $select_status->getValue();
    }
}