CopyrightHelperInterface.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Services\CopyrightHelper;

use ILIAS\MetaData\Services\Reader\ReaderInterface;
use ILIAS\MetaData\Services\Manipulator\ManipulatorInterface;
use ILIAS\MetaData\Search\Clauses\ClauseInterface as SearchClause;

interface CopyrightHelperInterface
{
    public function isCopyrightSelectionActive(): bool;

    public function hasPresetCopyright(ReaderInterface $reader): bool;

    public function readPresetCopyright(ReaderInterface $reader): CopyrightInterface;

    public function readCustomCopyright(ReaderInterface $reader): string;

    public function prepareCreateOrUpdateOfCopyrightFromPreset(
        ManipulatorInterface $manipulator,
        string $copyright_id
    ): ManipulatorInterface;

    public function prepareCreateOrUpdateOfCustomCopyright(
        ManipulatorInterface $manipulator,
        string $custom_copyright
    ): ManipulatorInterface;

    public function getAllCopyrightPresets(): \Generator;

    public function getNonOutdatedCopyrightPresets(): \Generator;

    public function getCopyrightSearchClause(
        string $first_copyright_id,
        string ...$further_copyright_ids
    ): SearchClause;
}