class.ilLPProgressBlockGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Tracking\View\Factory as ViewFactory;
use ILIAS\Tracking\View\DataRetrieval\FactoryInterface as DataRetrievalFactoryInterface;
use ILIAS\Tracking\View\Renderer\RendererInterface as RendererInterface;
 
class ilLPProgressBlockGUI extends ilBlockGUI
{
    protected DataRetrievalFactoryInterface $data_retrieval;
    protected RendererInterface $tracking_renderer;
 
    public function __construct()
    {
        parent::__construct();
 
        $view_factory = new ViewFactory();
        $this->data_retrieval = $view_factory->dataRetrieval();
        $this->tracking_renderer = $view_factory->renderer()->service();
 
        $this->lng->loadLanguageModule('trac');
 
        $this->setBlockId('lpprogress_' . $this->ctrl->getContextObjId());
        $this->setTitle($this->lng->txt('trac_progress_block_title'));
        $this->setPresentation(self::PRES_SEC_LEG);
        $this->setActions();
    }
 
    public function getBlockType(): string
    {
        return 'lpprogress';
    }
 
    protected function isRepositoryObject(): bool
    {
        return false;
    }
 
    protected function getLegacyContent(): string
    {
        $filter = $this->data_retrieval
            ->filter()
            ->withObjectIds(ilObject::_lookupObjectId($this->requested_ref_id))
            ->withUserIds($this->user->getId());
        $lp_info = $this->data_retrieval
            ->service()
            ->retrieveViewInfo($filter)
            ->lpInfoIterator()
            ->current();
 
        $status = $lp_info->getLPStatus();
 
        $progress = $this->tracking_renderer->fixedSizeProgressMeter($lp_info);
        $mode_and_status = $this->ui->factory()->item()->standard(
            ilLearningProgressBaseGUI::_getStatusText($status, $this->lng)
        )->withDescription(
            $this->lng->txt('trac_mode_collection')
        );
 
        return $this->ui->renderer()->render([
            $progress,
            $mode_and_status
        ]);
    }
 
    protected function setActions(): void
    {
        $read_only_allowed = true;
        if ($this->supportsMembers($this->requested_ref_id)) {
            $read_only_allowed = ilParticipants::_isParticipant($this->requested_ref_id, $this->user->getId());
        }
        if (!ilLearningProgressAccess::checkAccess($this->requested_ref_id, $read_only_allowed)) {
            return;
        }
        $this->ctrl->setParameterByClass(ilLearningProgressGUI::class, 'ref_id', $this->requested_ref_id);
        $link = $this->ctrl->getLinkTargetByClass(ilLearningProgressGUI::class);
        $this->ctrl->clearParameterByClass(ilLearningProgressGUI::class, 'ref_id');
        $this->addBlockCommand($link, $this->lng->txt('trac_progress_block_details'));
    }
 
    protected function supportsMembers(int $ref_id): bool
    {
        try {
            ilParticipants::getInstance($ref_id);
            return true;
        } catch (Exception) {
            return false;
        }
    }
}