class.ilLSTOCGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\KioskMode\TOCBuilder;

class ilLSTOCGUI extends ilExplorerBaseGUI
{
    public const NODE_ICONS = [
        TOCBuilder::LP_NOT_STARTED => "./templates/default/images/scorm/not_attempted.svg",
        TOCBuilder::LP_IN_PROGRESS => "./templates/default/images/scorm/incomplete.svg",
        TOCBuilder::LP_COMPLETED => "./templates/default/images/scorm/completed.svg",
        TOCBuilder::LP_FAILED => "./templates/default/images/scorm/failed.svg"
    ];

    protected array $structure;

    protected array $nodes = [];
    protected LSUrlBuilder $url_builder;
    protected int $counter = 0;

    protected array $node_icons = [
        TOCBuilder::LP_NOT_STARTED => '',
        TOCBuilder::LP_IN_PROGRESS => '',
        TOCBuilder::LP_COMPLETED => '',
        TOCBuilder::LP_FAILED => ''
    ];

    public function __construct(LSUrlBuilder $url_builder)
    {
        parent::__construct("lsq_toc", null, "");

        $this->url_builder = $url_builder;
        $this->setSkipRootNode(false);
        $this->setNodeOnclickEnabled(true);

        //get the image paths to the node icons
        $lp_icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);
        $this->node_icons[TOCBuilder::LP_NOT_STARTED] = $lp_icons->getImagePathNotAttempted();
        $this->node_icons[TOCBuilder::LP_COMPLETED] = $lp_icons->getImagePathCompleted();
        $this->node_icons[TOCBuilder::LP_IN_PROGRESS] = $lp_icons->getImagePathInProgress();
        $this->node_icons[TOCBuilder::LP_FAILED] = $lp_icons->getImagePathFailed();
    }

    public function withStructure(string $json_structure): self
    {
        $clone = clone $this;
        $clone->structure = $clone->addIds(json_decode($json_structure, true));
        $clone->buildLookup($clone->structure);
        $clone->open_nodes = array_keys($clone->nodes);
        return $clone;
    }

    protected function addIds(array $node): array
    {
        $node['_id'] = $this->counter;
        $this->counter++;
        if (array_key_exists('childs', $node)) {
            foreach ($node['childs'] as $idx => $child) {
                $node['childs'][$idx] = $this->addIds($child);
            }
        }
        return $node;
    }

    protected function buildLookup(array $node): void
    {
        $this->nodes[$node['_id']] = $node;
        if (array_key_exists('childs', $node)) {
            foreach ($node['childs'] as $child) {
                $this->buildLookup($child);
            }
        }
    }

    public function getRootNode()
    {
        return reset($this->nodes);
    }

    public function getChildsOfNode($a_parent_node_id): array
    {
        $parent_node = $this->nodes[$a_parent_node_id];
        return (array) ($parent_node['childs'] ?? []);
    }

    public function getNodeContent($a_node): string
    {
        return $a_node['label'];
    }

    public function getNodeIcon($a_node): string
    {
        $state = $a_node['state'] ?? TOCBuilder::LP_NOT_STARTED;
        return $this->node_icons[$state];
    }

    public function getNodeId($a_node)
    {
        return $a_node['_id'];
    }

    public function getNodeHref($a_node): string
    {
        return $this->url_builder->getHref($a_node['command'], $a_node['parameter']);
    }

    public function isNodeClickable($a_node): bool
    {
        return !is_null($a_node['parameter']);
    }

    public function isNodeHighlighted($a_node): bool
    {
        return $a_node['current'] ?? false;
    }
}