ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest Class Reference

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

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

Public Member Functions
	testIsCopyrightSelectionActiveTrue ()
	testIsCopyrightSelectionActiveFalse ()
	testCopyrightAsString ()
	testCopyrightAsStringInactiveCPSelection ()
	testCopyrightAsStringInvalidAsIdentifier ()
	testCopyrightAsStringEntryIdNotFound ()
	testCopyrightForExportInvalidAsIdentifier ()
	testCopyrightForExportEntryIdNotFound ()
	testCopyrightForExportInactiveCPSelection ()
	testCopyrightForExportEmpty ()
	testCopyrightForExportHasLink ()
	testCopyrightForExportHasFullName ()
	testCopyrightForExportHasFullNameAndLink ()
	testCopyrightForExportHasNoFullNameOrLink ()
	testCopyrightFromExportNoMatches ()
	testCopyrightFromExportURLWithNoMatchesShouldBeUnchanged ()
	testCopyrightFromExportNoMatchesContainsFullName ()
	testCopyrightFromExportInactiveCPSelection ()
	testCopyrightFromExportMatchesByFullName ()
	testCopyrightFromExportMultipleMatchesByFullName ()
	testCopyrightFromExportMatchesByLink ()
	testCopyrightFromExportMultipleMatchesByLink ()
	testCopyrightFromExportMatchesByLinkButDifferentScheme ()

Protected Member Functions
	getURI (string $link)
	getCopyrightEntry (int $id, string $full_name, ?string $link, bool $default=false)
	getCopyrightRepository (EntryInterface ... $entries)
	getIdentifierHandler ()
	getSettings (bool $selection_active)

Detailed Description

Definition at line 38 of file CopyrightHandlerTest.php.

Member Function Documentation

getCopyrightEntry()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::getCopyrightEntry ( int  $id, string  $full_name, ?string  $link, bool  $default = false  )

protected

Definition at line 47 of file CopyrightHandlerTest.php.

     : EntryInterface {
        $url = is_null($link) ? null : $this->getURI($link);
 
        return new class ($id, $full_name, $url, $default) extends NullEntry {
            public function __construct(
                protected int $id,
                protected string $full_name,
                protected ?URI $url,
                protected bool $default
            ) {
            }
 
            public function id(): int
            {
                return $this->id;
            }
 
            public function isDefault(): bool
            {
                return $this->default;
            }
 
            public function copyrightData(): CopyrightDataInterface
            {
                return new class ($this->full_name, $this->url) extends NullCopyrightData {
                    public function __construct(
                        protected string $full_name,
                        protected ?URI $url
                    ) {
                    }
 
                    public function fullName(): string
                    {
                        return $this->full_name;
                    }
 
                    public function link(): ?URI
                    {
                        return $this->url;
                    }
                };
            }
        };
    }

References $id, $url, ILIAS\__construct(), ILIAS\GlobalScreen\Provider\id(), and ILIAS\Repository\link().

Here is the call graph for this function:

getCopyrightRepository()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::getCopyrightRepository ( EntryInterface ...  $entries )

protected

Definition at line 97 of file CopyrightHandlerTest.php.

                                                                         : CopyrightRepository
    {
        return new class ($entries) extends NullRepository {
            public function __construct(protected array $entries)
            {
            }
 
            public function getAllEntries(): \Generator
            {
                yield from $this->entries;
            }
 
            public function getEntry(int $id): EntryInterface
            {
                foreach ($this->entries as $entry) {
                    if ($entry->id() === $id) {
                        return $entry;
                    }
                }
                return new NullEntry();
            }
 
            public function getDefaultEntry(): EntryInterface
            {
                foreach ($this->entries as $entry) {
                    if ($entry->isDefault()) {
                        return $entry;
                    }
                }
                return new NullEntry();
            }
        };
    }

References $id, ILIAS\__construct(), and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

getIdentifierHandler()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::getIdentifierHandler ( )

protected

Definition at line 131 of file CopyrightHandlerTest.php.

                                             : IdentifierHandler
    {
        return new class () extends NullHandler {
            public function isIdentifierValid(string $identifier): bool
            {
                return str_contains($identifier, 'valid_identifier_');
            }
 
            public function parseEntryIDFromIdentifier(string $identifier): int
            {
                return (int) str_replace('valid_identifier_', '', $identifier);
            }
 
            public function buildIdentifierFromEntryID(int $entry_id): string
            {
                return 'valid_identifier_' . $entry_id;
            }
        };
    }

getSettings()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::getSettings ( bool  $selection_active )

protected

Definition at line 151 of file CopyrightHandlerTest.php.

                                                          : SettingsInterface
    {
        return new class ($selection_active) extends NullSettings {
            public function __construct(protected bool $selection_active)
            {
            }
 
            public function isCopyrightSelectionActive(): bool
            {
                return $this->selection_active;
            }
        };
    }

References ILIAS\__construct().

Here is the call graph for this function:

getURI()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::getURI ( string  $link )

protected

Definition at line 40 of file CopyrightHandlerTest.php.

                                           : URI
    {
        $url = $this->createMock(URI::class);
        $url->method('__toString')->willReturn($link);
        return $url;
    }

References $url.

testCopyrightAsString()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightAsString

(

)

Definition at line 187 of file CopyrightHandlerTest.php.

                                           : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'http://www.example2.com',
            $handler->copyrightAsString('valid_identifier_55')
        );
    }

References $handler.

testCopyrightAsStringEntryIdNotFound()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightAsStringEntryIdNotFound

(

)

Definition at line 244 of file CopyrightHandlerTest.php.

                                                          : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            '',
            $handler->copyrightAsString('valid_identifier_678')
        );
    }

References $handler.

testCopyrightAsStringInactiveCPSelection()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightAsStringInactiveCPSelection

(

)

Definition at line 206 of file CopyrightHandlerTest.php.

                                                              : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(false)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightAsString('valid_identifier_55')
        );
    }

References $handler.

testCopyrightAsStringInvalidAsIdentifier()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightAsStringInvalidAsIdentifier

(

)

Definition at line 225 of file CopyrightHandlerTest.php.

                                                              : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'something invalid',
            $handler->copyrightAsString('something invalid')
        );
    }

References $handler.

testCopyrightForExportEmpty()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportEmpty

(

)

Definition at line 320 of file CopyrightHandlerTest.php.

                                                 : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com', true),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'http://www.example2.com',
            $handler->copyrightForExport('')
        );
    }

References $handler.

testCopyrightForExportEntryIdNotFound()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportEntryIdNotFound

(

)

Definition at line 282 of file CopyrightHandlerTest.php.

                                                           : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            '',
            $handler->copyrightForExport('valid_identifier_678')
        );
    }

References $handler.

testCopyrightForExportHasFullName()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportHasFullName

(

)

Definition at line 358 of file CopyrightHandlerTest.php.

                                                       : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', null),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'second entry',
            $handler->copyrightForExport('valid_identifier_55')
        );
    }

References $handler.

testCopyrightForExportHasFullNameAndLink()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportHasFullNameAndLink

(

)

Definition at line 377 of file CopyrightHandlerTest.php.

                                                              : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'http://www.example2.com',
            $handler->copyrightForExport('valid_identifier_55')
        );
    }

References $handler.

testCopyrightForExportHasLink()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportHasLink

(

)

Definition at line 339 of file CopyrightHandlerTest.php.

                                                   : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, '', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'http://www.example2.com',
            $handler->copyrightForExport('valid_identifier_55')
        );
    }

References $handler.

testCopyrightForExportHasNoFullNameOrLink()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportHasNoFullNameOrLink

(

)

Definition at line 396 of file CopyrightHandlerTest.php.

                                                               : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, '', null),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            '',
            $handler->copyrightForExport('valid_identifier_55')
        );
    }

References $handler.

testCopyrightForExportInactiveCPSelection()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportInactiveCPSelection

(

)

Definition at line 301 of file CopyrightHandlerTest.php.

                                                               : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(false)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightForExport('valid_identifier_55')
        );
    }

References $handler.

testCopyrightForExportInvalidAsIdentifier()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightForExportInvalidAsIdentifier

(

)

Definition at line 263 of file CopyrightHandlerTest.php.

                                                               : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', 'https://www.example1.com'),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'something invalid',
            $handler->copyrightForExport('something invalid')
        );
    }

References $handler.

testCopyrightFromExportInactiveCPSelection()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportInactiveCPSelection

(

)

Definition at line 476 of file CopyrightHandlerTest.php.

                                                                : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(false)
        );
 
        $this->assertSame(
            'some text containing http://www.example2.com',
            $handler->copyrightFromExport('some text containing http://www.example2.com')
        );
    }

References $handler.

testCopyrightFromExportMatchesByFullName()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportMatchesByFullName

(

)

Definition at line 495 of file CopyrightHandlerTest.php.

                                                              : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'valid_identifier_13',
            $handler->copyrightFromExport('first entry')
        );
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightFromExport('second entry')
        );
    }

References $handler.

testCopyrightFromExportMatchesByLink()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportMatchesByLink

(

)

Definition at line 537 of file CopyrightHandlerTest.php.

                                                          : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightFromExport('some text containing http://www.example2.com')
        );
    }

References $handler.

testCopyrightFromExportMatchesByLinkButDifferentScheme()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportMatchesByLinkButDifferentScheme

(

)

Definition at line 575 of file CopyrightHandlerTest.php.

                                                                            : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightFromExport('some text containing https://www.example2.com')
        );
    }

References $handler.

testCopyrightFromExportMultipleMatchesByFullName()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportMultipleMatchesByFullName

(

)

Definition at line 518 of file CopyrightHandlerTest.php.

                                                                      : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'second entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightFromExport('second entry')
        );
    }

References $handler.

testCopyrightFromExportMultipleMatchesByLink()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportMultipleMatchesByLink

(

)

Definition at line 556 of file CopyrightHandlerTest.php.

                                                                  : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'https://www.example3.com/something'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'valid_identifier_55',
            $handler->copyrightFromExport('some text containing https://www.example3.com/something')
        );
    }

References $handler.

testCopyrightFromExportNoMatches()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportNoMatches

(

)

Definition at line 415 of file CopyrightHandlerTest.php.

                                                      : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'just some text',
            $handler->copyrightFromExport('just some text')
        );
    }

References $handler.

testCopyrightFromExportNoMatchesContainsFullName()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportNoMatchesContainsFullName

(

)

Definition at line 457 of file CopyrightHandlerTest.php.

                                                                      : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'just some text which contains first entry',
            $handler->copyrightFromExport('just some text which contains first entry')
        );
    }

References $handler.

testCopyrightFromExportURLWithNoMatchesShouldBeUnchanged()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testCopyrightFromExportURLWithNoMatchesShouldBeUnchanged

(

)

Definition at line 434 of file CopyrightHandlerTest.php.

                                                                              : void
    {
        $entries = [
            $this->getCopyrightEntry(13, 'first entry', null),
            $this->getCopyrightEntry(55, 'second entry', 'http://www.example2.com'),
            $this->getCopyrightEntry(123, 'third entry', 'https://www.example3.com/something')
        ];
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(...$entries),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertSame(
            'https://www.nonmatching.com',
            $handler->copyrightFromExport('https://www.nonmatching.com')
        );
        $this->assertSame(
            'http://www.nonmatching.com',
            $handler->copyrightFromExport('http://www.nonmatching.com')
        );
    }

References $handler.

testIsCopyrightSelectionActiveFalse()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testIsCopyrightSelectionActiveFalse

(

)

Definition at line 176 of file CopyrightHandlerTest.php.

                                                         : void
    {
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(),
            $this->getIdentifierHandler(),
            $this->getSettings(false)
        );
 
        $this->assertFalse($handler->isCopyrightSelectionActive());
    }

References $handler.

testIsCopyrightSelectionActiveTrue()

ILIAS\MetaData\XML\Copyright\CopyrightHandlerTest::testIsCopyrightSelectionActiveTrue

(

)

Definition at line 165 of file CopyrightHandlerTest.php.

                                                        : void
    {
        $handler = new CopyrightHandler(
            $this->getCopyrightRepository(),
            $this->getIdentifierHandler(),
            $this->getSettings(true)
        );
 
        $this->assertTrue($handler->isCopyrightSelectionActive());
    }

References $handler.

---

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

• components/ILIAS/MetaData/tests/XML/Copyright/CopyrightHandlerTest.php