SubitemPropertiesReader.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\LearningModule\Search;
 
use ILIAS\Search\Presentation\Result\Subitem\PropertiesReader;
use ILIAS\DI\Container;
use ILIAS\Data\Factory as DataFactory;
use ilLanguage;
use ilObject;
use ILIAS\Search\Presentation\Result\Subitem\PropertiesFactory;
use ILIAS\Search\Presentation\Result\Subitem\ID;
use ilCtrlInterface;
use ILIAS\Search\Presentation\Result\Subitem\Properties;
use ilLMObject;
use ilLMPresentationGUI;
use Generator;
 
class SubitemPropertiesReader implements PropertiesReader
{
    protected ilLanguage $lng;
    protected DataFactory $data_factory;
    protected ilCtrlInterface $ctrl;
 
    public static function type(): string
    {
        return 'lm';
    }
 
    public function init(Container $dic): void
    {
        $this->lng = $dic->language();
        $this->data_factory = new DataFactory();
        $this->ctrl = $dic->ctrl();
    }
 
    public function getSubitemProperties(
        PropertiesFactory $factory,
        int $parent_ref_id,
        ID ...$subitem_ids
    ): Generator {
        $obj_id = ilObject::_lookupObjId($parent_ref_id);
        foreach ($subitem_ids as $subitem_id) {
            switch ($subitem_id->type()) {
                case 'pg':
                    yield $this->getPropertiesForLMObject(
                        $factory,
                        $parent_ref_id,
                        $subitem_id,
                        $this->lng->txt('obj_pg')
                    );
                    break;
 
                case 'st':
                    yield $this->getPropertiesForLMObject(
                        $factory,
                        $parent_ref_id,
                        $subitem_id,
                        $this->lng->txt('obj_st')
                    );
                    break;
 
                case 'file':
                    if (!ilObject::_exists((int) $subitem_id->id())) {
                        break;
                    }
                    yield $this->getPropertiesForFile($factory, $parent_ref_id, $subitem_id);
            }
        }
    }
 
    protected function getPropertiesForLMObject(
        PropertiesFactory $factory,
        int $parent_ref_id,
        ID $subitem_id,
        string $presentable_type
    ): Properties {
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'ref_id', $parent_ref_id);
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'obj_id', $subitem_id->id());
        $link = rtrim(ILIAS_HTTP_PATH, '/') . '/' .
            $this->ctrl->getLinkTargetByClass(ilLMPresentationGUI::class, '');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'obj_id');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'ref_id');
        return $factory->get(
            $subitem_id,
            ilLMObject::_lookupTitle((int) $subitem_id->id()),
            $this->data_factory->uri($link),
            false,
            $presentable_type
        );
    }
 
    protected function getPropertiesForFile(
        PropertiesFactory $factory,
        int $parent_ref_id,
        ID $subitem_id
    ): Properties {
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'ref_id', $parent_ref_id);
        $this->ctrl->setParameterByClass(ilLMPresentationGUI::class, 'file_id', 'il__file_' . $subitem_id->id());
        $link = rtrim(ILIAS_HTTP_PATH, '/') . '/' .
            $this->ctrl->getLinkTargetByClass(ilLMPresentationGUI::class, 'downloadFile');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'file_id');
        $this->ctrl->clearParameterByClass(ilLMPresentationGUI::class, 'ref_id');
        return $factory->get(
            $subitem_id,
            ilObject::_lookupTitle((int) $subitem_id->id()),
            $this->data_factory->uri($link),
            false,
            $this->lng->txt('obj_file')
        );
    }
}