LSChoicePageBuilder.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\LearningSequence\Player;
 
use ILIAS\UI\Factory;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Card\Card;
use ILIAS\UI\Component\Image\Image;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\ILIASObject\Properties\CoreProperties\TileImage\TileImage;
use ilLanguage;
 
class LSChoicePageBuilder
{
    public const HEADLINE = 'lso_choice_page_headline';
    public const START_LABEL = 'lso_choice_page_start_label';
 
    public function __construct(
        protected Factory $ui_factory,
        protected ilLanguage $lang,
        protected \ilObjectDataCache $obj_data_cache,
        protected \LSUrlBuilder $url_builder,
        protected string $goto_command
    ) {
    }
 
    public function getHeadline(): string
    {
        return $this->lang->txt(self::HEADLINE);
    }
 
    public function build(array $successors): array
    {
        $this->preloadObjects($successors);
 
        return [
            $this->ui_factory->deck(array_map(
                fn(\LSLearnerItem $successor): Card => $this->buildCard($successor),
                $successors
            ))->withSmallCardsSize()
        ];
    }
 
    public function buildCard(\LSLearnerItem $item): Card
    {
        $start_url = $this->getStartUrl($item);
 
        return $this->ui_factory->card()->repositoryObject(
            htmlspecialchars($item->getTitle()),
            $this->getTileImage($item)
        )->withObjectIcon(
            $this->getObjectIcon($item)
        )->withTitleAction(
            $start_url
        )->withSections(
            $this->getSections($item, $start_url)
        );
    }
 
    protected function getStartUrl(\LSLearnerItem $item): string
    {
        return $this->url_builder->getHref(
            $this->goto_command,
            $this->obj_data_cache->lookupObjId($item->getRefId())
        );
    }
 
    protected function getSections(\LSLearnerItem $item, string $start_url): array
    {
        $sections = [];
        $description = trim($item->getDescription());
        if ($description !== '') {
            $sections[] = $this->ui_factory->listing()->property()
                ->withProperty($this->lang->txt('description'), $description, false);
        }
        $sections[] = $this->ui_factory->button()->standard($this->lang->txt(self::START_LABEL), $start_url);
 
        return $sections;
    }
 
    protected function getObjectIcon(\LSLearnerItem $item): Icon
    {
        $label = $this->lang->txt('obj_' . $item->getType());
        if ($item->getIconPath() !== '') {
            return $this->ui_factory->symbol()->icon()->custom($item->getIconPath(), $label, Icon::MEDIUM);
        }
 
        return $this->ui_factory->symbol()->icon()->standard($item->getType(), $label, Icon::MEDIUM);
    }
 
    protected function preloadObjects(array $successors): void
    {
        $this->obj_data_cache->preloadReferenceCache(
            array_map(static fn(\LSLearnerItem $successor): int => $successor->getRefId(), $successors)
        );
    }
 
    protected function getTileImage(\LSLearnerItem $item): Image
    {
        $tile_image = $this->getObjectTileImage($item);
        if ($tile_image !== null) {
            return $tile_image->getImage($this->ui_factory->image())->withAlt($item->getTitle());
        }
 
        $path = \ilUtil::getImagePath('cont_tile/cont_tile_default_' . $item->getType() . '.svg');
        if (!is_file($path)) {
            $path = \ilUtil::getImagePath('cont_tile/cont_tile_default.svg');
        }
 
        return $this->ui_factory->image()->responsive($path, $item->getTitle());
    }
 
    protected function getObjectTileImage(\LSLearnerItem $item): ?TileImage
    {
        $obj_id = $this->obj_data_cache->lookupObjId($item->getRefId());
        $object = $obj_id > 0 ? \ilObjectFactory::getInstanceByObjId($obj_id, false) : null;
 
        return $object?->getObjectProperties()->getPropertyTileImage()->getTileImage();
    }
}