Inheritance diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper:

Collaboration diagram for ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper:

Public Member Functions
	__construct (SettingsInterface $settings, PathFactory $path_factory, CopyrightRepository $copyright_repo, IdentifierHandler $identifier_handler, RendererInterface $renderer, SearchClauseFactory $search_clause_factory)

	isCopyrightSelectionActive ()
	If copyright selection is not active, there are no copyright presets to choose from, but copyright information can still be added manually to the LOM of objects. More...

	hasPresetCopyright (ReaderInterface $reader)
	Is the copyright in the LOM of the reader's object selected from the presets? If not, custom copyright information was entered manually. More...

	readPresetCopyright (ReaderInterface $reader)
	If possible, returns the preset copyright selected for the reader's object. More...

	readCustomCopyright (ReaderInterface $reader)
	Returns the custom copyright information from the LOM of the reader's object. More...

	prepareCreateOrUpdateOfCopyrightFromPreset (ManipulatorInterface $manipulator, string $copyright_id)
	The preset copyright with the given identifier is set to be selected for the manipulator's object. More...

	prepareCreateOrUpdateOfCustomCopyright (ManipulatorInterface $manipulator, string $custom_copyright)
	The given copyright information is set to be written to the LOM of the manipulator's object. More...

	getAllCopyrightPresets ()

	getNonOutdatedCopyrightPresets ()

	getCopyrightSearchClause (string $first_copyright_id, string ... $further_copyright_ids)
	Get a search clause that finds object with one of the given copyright entries in their LOM, to be used in {. More...

	isCopyrightSelectionActive ()
	If copyright selection is not active, there are no copyright presets to choose from, but copyright information can still be added manually to the LOM of objects. More...

	hasPresetCopyright (ReaderInterface $reader)
	Is the copyright in the LOM of the reader's object selected from the presets? If not, custom copyright information was entered manually. More...

	readPresetCopyright (ReaderInterface $reader)
	If possible, returns the preset copyright selected for the reader's object. More...

	readCustomCopyright (ReaderInterface $reader)
	Returns the custom copyright information from the LOM of the reader's object. More...

	prepareCreateOrUpdateOfCopyrightFromPreset (ManipulatorInterface $manipulator, string $copyright_id)
	The preset copyright with the given identifier is set to be selected for the manipulator's object. More...

	prepareCreateOrUpdateOfCustomCopyright (ManipulatorInterface $manipulator, string $custom_copyright)
	The given copyright information is set to be written to the LOM of the manipulator's object. More...

	getAllCopyrightPresets ()
	Returns all preset copyright entries, or nothing if copyright selection is not active. More...

	getNonOutdatedCopyrightPresets ()
	Returns all preset copyright entries that are not marked as outdated, or nothing if copyright selection is not active. More...

	getCopyrightSearchClause (string $first_copyright_id, string ... $further_copyright_ids)
	Get a search clause that finds object with one of the given copyright entries in their LOM, to be used in {. More...

Protected Member Functions
	prepareCreateOrUpdateOfCopyright (ManipulatorInterface $manipulator, string $value)

	getRawCopyright (ReaderInterface $reader)

	getCopyrightDescriptionPath ()

	getCopyrightEntryWrapper (EntryInterface $entry)

	getNullCopyrightEntryWrapper ()

Protected Attributes
SettingsInterface	$settings

PathFactory	$path_factory

IdentifierHandler	$identifier_handler

CopyrightRepository	$copyright_repo

RendererInterface	$renderer

SearchClauseFactory	$search_clause_factory

Detailed Description

Definition at line 37 of file CopyrightHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::__construct	(	SettingsInterface	$settings,
		PathFactory	$path_factory,
		CopyrightRepository	$copyright_repo,
		IdentifierHandler	$identifier_handler,
		RendererInterface	$renderer,
		SearchClauseFactory	$search_clause_factory
	)

Definition at line 46 of file CopyrightHelper.php.

      {
        $this->settings = $settings;
        $this->path_factory = $path_factory;
        $this->copyright_repo = $copyright_repo;
        $this->identifier_handler = $identifier_handler;
        $this->renderer = $renderer;
        $this->search_clause_factory = $search_clause_factory;
    }

References ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$copyright_repo, ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$identifier_handler, ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$path_factory, ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$renderer, ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$search_clause_factory, ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\$settings, renderer(), and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getClauseFactory(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getCopyrightEntry(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getCopyrightHelper(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getPathFactory(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getReader(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightTest\getRenderer(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ getAllCopyrightPresets()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getAllCopyrightPresets ( )

Returns: CopyrightInterface[]

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 133 of file CopyrightHelper.php.

                                            : \Generator
    {
        if (!$this->isCopyrightSelectionActive()) {
            return;
        }
 
        foreach ($this->copyright_repo->getAllEntries() as $entry) {
            yield $this->getCopyrightEntryWrapper($entry);
        }
    }

◆ getCopyrightDescriptionPath()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getCopyrightDescriptionPath ( )

protected

Definition at line 211 of file CopyrightHelper.php.

                                                    : PathInterface
    {
        return $this->path_factory->custom()
                                  ->withNextStep('rights')
                                  ->withNextStep('description')
                                  ->withNextStep('string')
                                  ->get();
    }

◆ getCopyrightEntryWrapper()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getCopyrightEntryWrapper ( EntryInterface $entry )

protected

Definition at line 220 of file CopyrightHelper.php.

                                                                      : CopyrightInterface
    {
        return new Copyright(
            $this->renderer,
            $this->identifier_handler,
            $entry
        );
    }

References renderer().

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readPresetCopyright().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCopyrightSearchClause()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getCopyrightSearchClause	(	string	$first_copyright_id,
		string ...	$further_copyright_ids
	)

Get a search clause that finds object with one of the given copyright entries in their LOM, to be used in {.

See also: \ILIAS\MetaData\Services\Search\SearcherInterface::execute()}.

If copyright selection is active, objects without any copyright information are treated as if they had the default copyright.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 158 of file CopyrightHelper.php.

     : SearchClause {
        $selection_active = $this->isCopyrightSelectionActive();
        $default_entry_id = 0;
        if ($selection_active) {
            $default_entry_id = $this->copyright_repo->getDefaultEntry()->id();
        }
 
        $copyright_search_clauses = [];
        foreach ([$first_copyright_id, ...$further_copyright_ids] as $copyright_id) {
            $copyright_search_clauses[] = $this->search_clause_factory->getBasicClause(
                $this->getCopyrightDescriptionPath(),
                Mode::EQUALS,
                $copyright_id
            );
 
            if (
                !$selection_active ||
                !$this->identifier_handler->isIdentifierValid($copyright_id) ||
                $this->identifier_handler->parseEntryIDFromIdentifier($copyright_id) !== $default_entry_id
            ) {
                continue;
            }
            $copyright_search_clauses[] = $this->search_clause_factory->getBasicClause(
                $this->getCopyrightDescriptionPath(),
                Mode::EQUALS,
                ''
            );
        }
 
        return $this->search_clause_factory->getJoinedClauses(
            Operator::OR,
            ...$copyright_search_clauses
        );
    }

◆ getNonOutdatedCopyrightPresets()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getNonOutdatedCopyrightPresets ( )

Returns: CopyrightInterface[]

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 147 of file CopyrightHelper.php.

                                                    : \Generator
    {
        if (!$this->isCopyrightSelectionActive()) {
            return;
        }
 
        foreach ($this->copyright_repo->getActiveEntries() as $entry) {
            yield $this->getCopyrightEntryWrapper($entry);
        }
    }

◆ getNullCopyrightEntryWrapper()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getNullCopyrightEntryWrapper ( )

protected

Definition at line 229 of file CopyrightHelper.php.

                                                     : CopyrightInterface
    {
        return new NullCopyright();
    }

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readPresetCopyright().

Here is the caller graph for this function:

◆ getRawCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::getRawCopyright ( ReaderInterface $reader )

protected

Definition at line 206 of file CopyrightHelper.php.

                                                               : string
    {
        return $reader->firstData($this->getCopyrightDescriptionPath())->value();
    }

References ILIAS\MetaData\Services\Reader\ReaderInterface\firstData().

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\hasPresetCopyright(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readCustomCopyright(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readPresetCopyright().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPresetCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::hasPresetCopyright ( ReaderInterface $reader )

Is the copyright in the LOM of the reader's object selected from the presets? If not, custom copyright information was entered manually.

If no copyright is assigned to the object, it is treated like it has the default copyright licence, and true is returned here.

Always returns false if copyright selection is not active.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 67 of file CopyrightHelper.php.

                                                               : bool
    {
        if (!$this->isCopyrightSelectionActive()) {
            return false;
        }
        $raw = $this->getRawCopyright($reader);
 
        if ($raw === '') {
            return true;
        }
 
        return $this->identifier_handler->isIdentifierValid($this->getRawCopyright($reader));
    }

References ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\getRawCopyright(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\isCopyrightSelectionActive().

Here is the call graph for this function:

◆ isCopyrightSelectionActive()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::isCopyrightSelectionActive ( )

If copyright selection is not active, there are no copyright presets to choose from, but copyright information can still be added manually to the LOM of objects.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 62 of file CopyrightHelper.php.

                                                : bool
    {
        return $this->settings->isCopyrightSelectionActive();
    }

References ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperTest\getSettings(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\hasPresetCopyright(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readCustomCopyright(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\readPresetCopyright().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareCreateOrUpdateOfCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::prepareCreateOrUpdateOfCopyright	(	ManipulatorInterface	$manipulator,
		string	$value
	)

protected

Definition at line 196 of file CopyrightHelper.php.

     : ManipulatorInterface {
        return $manipulator->prepareCreateOrUpdate(
            $this->getCopyrightDescriptionPath(),
            $value
        );
    }

◆ prepareCreateOrUpdateOfCopyrightFromPreset()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::prepareCreateOrUpdateOfCopyrightFromPreset	(	ManipulatorInterface	$manipulator,
		string	$copyright_id
	)

The preset copyright with the given identifier is set to be selected for the manipulator's object.

Note that this will also overwrite custom copyright information.

Call {

See also: \ILIAS\MetaData\Services\Manipulator\ManipulatorInterface::execute()} to carry out the changes.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 116 of file CopyrightHelper.php.

     : ManipulatorInterface {
        return $this->prepareCreateOrUpdateOfCopyright($manipulator, $copyright_id);
    }

◆ prepareCreateOrUpdateOfCustomCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::prepareCreateOrUpdateOfCustomCopyright	(	ManipulatorInterface	$manipulator,
		string	$custom_copyright
	)

The given copyright information is set to be written to the LOM of the manipulator's object.

Note that this will also overwrite any selected preset copyright.

Call {

See also: \ILIAS\MetaData\Services\Manipulator\ManipulatorInterface::execute()} to carry out the changes.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 123 of file CopyrightHelper.php.

     : ManipulatorInterface {
        return $this->prepareCreateOrUpdateOfCopyright($manipulator, $custom_copyright);
    }

◆ readCustomCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::readCustomCopyright ( ReaderInterface $reader )

Returns the custom copyright information from the LOM of the reader's object.

If copyright selection is inactive, or one of the preset copyright options was selected for the object, this returns an empty string.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 103 of file CopyrightHelper.php.

                                                                : string
    {
        $copyright = $this->getRawCopyright($reader);
 
        if (
            !$this->isCopyrightSelectionActive() ||
            $this->identifier_handler->isIdentifierValid($copyright)
        ) {
            return '';
        }
        return $copyright;
    }

References ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\getRawCopyright(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\isCopyrightSelectionActive().

Here is the call graph for this function:

◆ readPresetCopyright()

ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::readPresetCopyright ( ReaderInterface $reader )

If possible, returns the preset copyright selected for the reader's object.

For objects which have no copyright information in their LOM, the default copyright is returned (as long as copyright selection is active).

Returns a null object if copyright selection is not active, or if the object has custom copyright information.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelperInterface.

Definition at line 81 of file CopyrightHelper.php.

                                                                : CopyrightInterface
    {
        if (!$this->isCopyrightSelectionActive()) {
            return $this->getNullCopyrightEntryWrapper();
        }
        $raw = $this->getRawCopyright($reader);
 
        $entry = null;
        if ($this->identifier_handler->isIdentifierValid($raw)) {
            $entry = $this->copyright_repo->getEntry(
                $this->identifier_handler->parseEntryIDFromIdentifier($raw)
            );
        } elseif ($raw === '') {
            $entry = $this->copyright_repo->getDefaultEntry();
        }
 
        if (is_null($entry)) {
            return $this->getNullCopyrightEntryWrapper();
        }
        return $this->getCopyrightEntryWrapper($entry);
    }

References ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\getCopyrightEntryWrapper(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\getNullCopyrightEntryWrapper(), ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\getRawCopyright(), and ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\isCopyrightSelectionActive().

Here is the call graph for this function:

Field Documentation

◆ $copyright_repo

CopyrightRepository ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$copyright_repo

protected

Definition at line 42 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

◆ $identifier_handler

IdentifierHandler ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$identifier_handler

protected

Definition at line 41 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

◆ $path_factory

PathFactory ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$path_factory

protected

Definition at line 40 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

◆ $renderer

RendererInterface ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$renderer

protected

Definition at line 43 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

◆ $search_clause_factory

SearchClauseFactory ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$search_clause_factory

protected

Definition at line 44 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

◆ $settings

SettingsInterface ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper::$settings

protected

Definition at line 39 of file CopyrightHelper.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\CopyrightHelper\__construct().

The documentation for this class was generated from the following file:

components/ILIAS/MetaData/classes/Services/CopyrightHelper/CopyrightHelper.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAllCopyrightPresets()

◆ getCopyrightDescriptionPath()

◆ getCopyrightEntryWrapper()

◆ getCopyrightSearchClause()

◆ getNonOutdatedCopyrightPresets()

◆ getNullCopyrightEntryWrapper()

◆ getRawCopyright()

◆ hasPresetCopyright()

◆ isCopyrightSelectionActive()

◆ prepareCreateOrUpdateOfCopyright()

◆ prepareCreateOrUpdateOfCopyrightFromPreset()

◆ prepareCreateOrUpdateOfCustomCopyright()

◆ readCustomCopyright()

◆ readPresetCopyright()

Field Documentation

◆ $copyright_repo

◆ $identifier_handler

◆ $path_factory

◆ $renderer

◆ $search_clause_factory

◆ $settings