class.ilMDCopyrightUsageGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory;
use ILIAS\MetaData\Copyright\EntryInterface;

class ilMDCopyrightUsageGUI
{
    public const string DEFAULT_CMD = 'showUsageTable';

    protected EntryInterface $entry;

    protected ilGlobalTemplateInterface $tpl;
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected ilTabsGUI $tabs;
    protected GlobalHttpState $http;
    protected Factory $refinery;

    public function __construct(EntryInterface $entry)
    {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->http = $DIC->http();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->refinery = $DIC->refinery();

        $this->entry = $entry;
    }

    public function executeCommand(): void
    {
        // save usage id for all request
        $this->ctrl->saveParameter($this, 'entry_id');

        $user = '';
        if ($this->http->wrapper()->query()->has('user')) {
            $user = $this->http->wrapper()->query()->retrieve(
                'user',
                $this->refinery->kindlyTo()->string()
            );
        }

        $this->setTabs();
        $next_class = $this->ctrl->getNextClass($this);
        switch ($this->ctrl->getNextClass($this)) {
            case 'ilpublicuserprofilegui':
                $profile_gui = new ilPublicUserProfileGUI($this->http->wrapper()->query()->retrieve(
                    'user',
                    $this->refinery->kindlyTo()->int()
                ));
                $profile_gui->setBackUrl(
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD)
                );
                $html = $this->ctrl->forwardCommand($profile_gui);
                $this->tpl->setContent($html);
                break;

            default:
                $cmd = $this->ctrl->getCmd(self::DEFAULT_CMD);
                $this->$cmd();
                break;
        }
    }

    public function showUsageTable(): void
    {
        $this->tpl->setOnScreenMessage('info', $this->lng->txt("meta_info_only_repository_objects"));

        $table_gui = new ilMDCopyrightUsageTableGUI(
            $this,
            self::DEFAULT_CMD,
        );
        $table_gui->setFilterCommand("applyUsageFilter");
        $table_gui->setResetCommand("resetUsageFilter");
        $table_gui->init();
        $table_gui->parse();

        $this->tpl->setContent($table_gui->getHTML());
    }

    public function getEntryId(): int
    {
        return $this->entry->id();
    }

    public function getEntryTitle(): string
    {
        return $this->entry->title();
    }

    protected function applyUsageFilter(): void
    {
        $table_gui = new ilMDCopyrightUsageTableGUI(
            $this,
            self::DEFAULT_CMD,
        );
        $table_gui->init();
        $table_gui->resetOffset();        // sets record offset to 0 (first page)
        $table_gui->writeFilterToSession();    // writes filter to session

        $this->ctrl->redirect($this, self::DEFAULT_CMD);
    }

    protected function resetUsageFilter(): void
    {
        $table_gui = new ilMDCopyrightUsageTableGUI(
            $this,
            self::DEFAULT_CMD,
        );
        $table_gui->init();
        $table_gui->resetOffset();        // sets record offest to 0 (first page)
        $table_gui->resetFilter();        // clears filter

        $this->ctrl->redirect($this, self::DEFAULT_CMD);
    }

    protected function setTabs(): void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getParentReturn($this)
        );
    }
}