CopyrightHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Editor\Digest;

use ILIAS\MetaData\Copyright\RepositoryInterface;
use ILIAS\MetaData\Copyright\EntryInterface;

class CopyrightHandler
{
    protected RepositoryInterface $repository;

    protected array $entries;

    protected array $statuses = [];

    public function __construct(RepositoryInterface $repository)
    {
        $this->repository = $repository;
    }

    public function isCPSelectionActive(): bool
    {
        $settings = \ilMDSettings::_getInstance();
        return $settings->isCopyrightSelectionActive() && $this->hasCPEntries();
    }

    protected function getOerHarvesterSettings(): \ilOerHarvesterSettings
    {
        return \ilOerHarvesterSettings::getInstance();
    }

    public function doesObjectTypeSupportHarvesting(string $type): bool
    {
        return $this->getOerHarvesterSettings()->supportsHarvesting($type);
    }

    public function isCopyrightTemplateActive(EntryInterface $entry): bool
    {
        return $this->getOerHarvesterSettings()->isActiveCopyrightTemplate($entry->id());
    }

    protected function hasCPEntries(): bool
    {
        $this->initCPEntries();
        return !empty($this->entries);
    }

    public function getCPEntries(): \Generator
    {
        $this->initCPEntries();
        yield from $this->entries;
    }

    protected function initCPEntries(): void
    {
        if (!isset($this->entries)) {
            $this->entries = iterator_to_array($this->repository->getAllEntries());
        }
    }

    public function extractCPEntryID(string $description): int
    {
        return \ilMDCopyrightSelectionEntry::_extractEntryId($description);
    }

    public function createIdentifierForID(int $entry_id): string
    {
        return \ilMDCopyrightSelectionEntry::createIdentifier($entry_id);
    }

    public function isOerHarvesterBlocked(int $obj_id): bool
    {
        $status = $this->getHarvesterStatus($obj_id);
        return $status->isBlocked();
    }

    public function setOerHarvesterBlocked(
        int $obj_id,
        bool $is_blocked
    ): void {
        $status = $this->getHarvesterStatus($obj_id);
        $status->setBlocked($is_blocked);
        $status->save();
    }

    protected function getHarvesterStatus(int $obj_id): \ilOerHarvesterObjectStatus
    {
        if (isset($this->statuses[$obj_id])) {
            return $this->statuses[$obj_id];
        }
        return $this->statuses[$obj_id] = new \ilOerHarvesterObjectStatus($obj_id);
    }
}