ILIAS\MetaData\XML\Copyright\CopyrightHandler Class Reference

Inheritance diagram for ILIAS\MetaData\XML\Copyright\CopyrightHandler:

Collaboration diagram for ILIAS\MetaData\XML\Copyright\CopyrightHandler:

Public Member Functions
	__construct (CopyrightRepository $copyright_repository, IdentifierHandler $identifier_handler, SettingsInterface $settings)
	copyrightForExport (string $copyright)
	copyrightFromExport (string $copyright)
	copyrightAsString (string $copyright)
	isCopyrightSelectionActive ()

Protected Member Functions
	getAllCopyrightEntries ()

Protected Attributes
CopyrightRepository	$copyright_repository
IdentifierHandler	$identifier_handler
SettingsInterface	$settings
array	$copyright_entries

Detailed Description

Definition at line 29 of file CopyrightHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::__construct	(	CopyrightRepository	$copyright_repository,
		IdentifierHandler	$identifier_handler,
		SettingsInterface	$settings
	)

Definition at line 40 of file CopyrightHandler.php.

References ILIAS\MetaData\XML\Copyright\CopyrightHandler\$copyright_repository, ILIAS\MetaData\XML\Copyright\CopyrightHandler\$identifier_handler, ILIAS\MetaData\XML\Copyright\CopyrightHandler\$settings, and ILIAS\Repository\settings().

      {
        $this->copyright_repository = $copyright_repository;
        $this->identifier_handler = $identifier_handler;
        $this->settings = $settings;
    }

Here is the call graph for this function:

Member Function Documentation

copyrightAsString()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::copyrightAsString

(

string

$copyright

)

Implements ILIAS\MetaData\XML\Copyright\CopyrightHandlerInterface.

Definition at line 86 of file CopyrightHandler.php.

References ILIAS\MetaData\XML\Copyright\CopyrightHandler\isCopyrightSelectionActive().

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\copyrightForExport().

                                                        : string
    {
        if (!$this->isCopyrightSelectionActive()) {
            return $copyright;
        }

        if (!$this->identifier_handler->isIdentifierValid($copyright) && $copyright !== '') {
            return $copyright;
        }

        if ($copyright === '') {
            $entry_data = $this->copyright_repository->getDefaultEntry()->copyrightData();
        } else {
            $entry_id = $this->identifier_handler->parseEntryIDFromIdentifier($copyright);
            $entry_data = $this->copyright_repository->getEntry($entry_id)->copyrightData();
        }
        $full_name = $entry_data->fullName();
        $link = $entry_data->link();

        if (!is_null($link)) {
            return (string) $link;
        }
        return $full_name;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyrightForExport()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::copyrightForExport

(

string

$copyright

)

Implements ILIAS\MetaData\XML\Copyright\CopyrightHandlerInterface.

Definition at line 50 of file CopyrightHandler.php.

References ILIAS\MetaData\XML\Copyright\CopyrightHandler\copyrightAsString().

                                                         : string
    {
        return $this->copyrightAsString($copyright);
    }

Here is the call graph for this function:

copyrightFromExport()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::copyrightFromExport

(

string

$copyright

)

Implements ILIAS\MetaData\XML\Copyright\CopyrightHandlerInterface.

Definition at line 55 of file CopyrightHandler.php.

References ILIAS\MetaData\XML\Copyright\CopyrightHandler\getAllCopyrightEntries(), ILIAS\MetaData\XML\Copyright\CopyrightHandler\isCopyrightSelectionActive(), and null.

                                                          : string
    {
        if (!$this->isCopyrightSelectionActive()) {
            return $copyright;
        }

        // url should be made to match regardless of scheme
        $normalized_copyright = str_replace('https://', 'http://', $copyright);

        $matches_by_name = null;
        foreach ($this->getAllCopyrightEntries() as $entry) {
            $entry_link = (string) $entry->copyrightData()->link();
            $normalized_link = str_replace('https://', 'http://', $entry_link);
            if ($normalized_link !== '' && str_contains($normalized_copyright, $normalized_link)) {
                return $this->identifier_handler->buildIdentifierFromEntryID($entry->id());
            }

            if (
                is_null($matches_by_name) &&
                trim($copyright) === trim($entry->copyrightData()->fullName())
            ) {
                $matches_by_name = $this->identifier_handler->buildIdentifierFromEntryID($entry->id());
            }
        }

        if (!is_null($matches_by_name)) {
            return $matches_by_name;
        }
        return $copyright;
    }

Here is the call graph for this function:

getAllCopyrightEntries()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::getAllCopyrightEntries ( )

protected

Returns

EntryInterface[]

Definition at line 114 of file CopyrightHandler.php.

References ILIAS\MetaData\XML\Copyright\CopyrightHandler\$copyright_entries, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\copyrightFromExport().

                                               : \Generator
    {
        if (!isset($this->copyright_entries)) {
            $this->copyright_entries = iterator_to_array($this->copyright_repository->getAllEntries());
        }
        yield from $this->copyright_entries;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isCopyrightSelectionActive()

ILIAS\MetaData\XML\Copyright\CopyrightHandler::isCopyrightSelectionActive

(

)

Implements ILIAS\MetaData\XML\Copyright\CopyrightHandlerInterface.

Definition at line 122 of file CopyrightHandler.php.

References ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\copyrightAsString(), and ILIAS\MetaData\XML\Copyright\CopyrightHandler\copyrightFromExport().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$copyright_entries

array ILIAS\MetaData\XML\Copyright\CopyrightHandler::$copyright_entries

protected

Definition at line 38 of file CopyrightHandler.php.

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\getAllCopyrightEntries().

$copyright_repository

CopyrightRepository ILIAS\MetaData\XML\Copyright\CopyrightHandler::$copyright_repository

protected

Definition at line 31 of file CopyrightHandler.php.

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\__construct().

$identifier_handler

IdentifierHandler ILIAS\MetaData\XML\Copyright\CopyrightHandler::$identifier_handler

protected

Definition at line 32 of file CopyrightHandler.php.

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\__construct().

$settings

SettingsInterface ILIAS\MetaData\XML\Copyright\CopyrightHandler::$settings

protected

Definition at line 33 of file CopyrightHandler.php.

Referenced by ILIAS\MetaData\XML\Copyright\CopyrightHandler\__construct().

---

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

• components/ILIAS/MetaData/classes/XML/Copyright/CopyrightHandler.php