ILIAS\MetaData\OERHarvester\Publisher\PublisherTest Class Reference

Inheritance diagram for ILIAS\MetaData\OERHarvester\Publisher\PublisherTest:

Collaboration diagram for ILIAS\MetaData\OERHarvester\Publisher\PublisherTest:

Public Member Functions
	testBlock ()
	testUnblock ()
	testPublish ()
	testPublishWithAlreadyExportedObject ()
	testPublishWithAlreadyExistingRecord ()
	testWithdraw ()
	testWithdrawWithOnlyOneReference ()
	testWithdrawWithAutomaticPublishing ()
	testSubmit ()
	testSubmitWithAlreadyExportedObject ()
	testAccept ()
	testAcceptWithAlreadyExistingRecord ()
	testReject ()
	testRejectWithOnlyOneReference ()
	testRejectWithAutomaticPublishing ()

Protected Member Functions
	getSettings (int $editorial_ref_id=0, int $publishing_ref_id=0, bool $automatic_publishing_enabled=false,)
	getObjectHandler (array $exclusive_ref_ids=[],)
	Returned ref_ids are always given by concatenation of target ref_id and obj_id. More...
	getExportHandler (int ... $already_have_export_obj_ids)
	getStatusRepository (array $currently_harvested=[])
	Currently harvested objects are passed as obj_id => href_id. More...
	getExposedRecordRepository (int ... $has_record_obj_ids,)
	getXMLWriter (array $returned_md=[])
	Metadata is passed as array via obj_id => metadata-xml as string. More...
	getNullAccess ()

Detailed Description

Definition at line 50 of file PublisherTest.php.

Member Function Documentation

getExportHandler()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getExportHandler ( int ...  $already_have_export_obj_ids )

protected

Definition at line 124 of file PublisherTest.php.

     : ExportHandler {
        return new class ($already_have_export_obj_ids) extends NullExportHandler {
            public array $exposed_created_exports_obj_ids = [];
 
            public function __construct(
                protected array $already_have_export_obj_ids
            ) {
            }
 
            public function hasPublicAccessExport(int $obj_id): bool
            {
                return in_array($obj_id, $this->already_have_export_obj_ids);
            }
 
            public function createPublicAccessExport(int $obj_id): void
            {
                $this->exposed_created_exports_obj_ids[] = $obj_id;
            }
        };
    }

getExposedRecordRepository()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getExposedRecordRepository ( int ...  $has_record_obj_ids )

protected

Definition at line 191 of file PublisherTest.php.

     : ExposedRecordRepository {
        return new class ($has_record_obj_ids) extends NullExposedRecordRepository {
            public array $exposed_deletions = [];
            public array $exposed_updates = [];
            public array $exposed_creations = [];
 
            public function __construct(
                protected array $has_record_obj_ids
            ) {
            }
 
            public function doesRecordExistForObjID(int $obj_id): bool
            {
                return in_array($obj_id, $this->has_record_obj_ids);
            }
 
            public function updateRecord(int $obj_id, bool $is_deleted, ?\DOMDocument $metadata): void
            {
                $this->exposed_updates[] = [
                    'obj_id' => $obj_id,
                    'deleted' => $is_deleted,
                    'metadata' => $metadata?->saveXML()
                ];
            }
 
            public function createRecord(int $obj_id, string $identifier, \DOMDocument $metadata): void
            {
                $this->exposed_creations[] = [
                    'obj_id' => $obj_id,
                    'identifier' => $identifier,
                    'metadata' => $metadata->saveXML()
                ];
            }
        };
    }

getNullAccess()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getNullAccess ( )

protected

Definition at line 256 of file PublisherTest.php.

                                      : \ilAccess
    {
        return $this->createMock(\ilAccess::class);
    }

getObjectHandler()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getObjectHandler ( array  $exclusive_ref_ids = [] )

protected

Returned ref_ids are always given by concatenation of target ref_id and obj_id.

Definition at line 89 of file PublisherTest.php.

     : ObjectHandler {
        return new class ($exclusive_ref_ids) extends NullObjectHandler {
            public array $exposed_ref_creations = [];
            public array $exposed_ref_deletions = [];
 
            public function __construct(
                protected array $exclusive_ref_ids
            ) {
            }
 
            public function referenceObjectInTargetContainer(int $obj_id, int $container_ref_id): int
            {
                $new_ref_id = (int) ($container_ref_id . $obj_id);
                $this->exposed_ref_creations[] = [
                    'obj_id' => $obj_id,
                    'container_ref_id' => $container_ref_id,
                    'new_ref_id' => $new_ref_id
                ];
                return $new_ref_id;
            }
 
            public function isOnlyReference(int $ref_id): bool
            {
                return in_array($ref_id, $this->exclusive_ref_ids);
            }
 
            public function deleteReference(int $ref_id): void
            {
                $this->exposed_ref_deletions[] = $ref_id;
            }
        };
    }

getSettings()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getSettings ( int  $editorial_ref_id = 0, int  $publishing_ref_id = 0, bool  $automatic_publishing_enabled = false  )

protected

Definition at line 52 of file PublisherTest.php.

     : SettingsInterface {
        return new class (
            $editorial_ref_id,
            $publishing_ref_id,
            $automatic_publishing_enabled
        ) extends NullSettings {
            public function __construct(
                protected int $editorial_ref_id,
                protected int $publishing_ref_id,
                protected bool $automatic_publishing_enabled
            ) {
            }
 
            public function isAutomaticPublishingEnabled(): bool
            {
                return $this->automatic_publishing_enabled;
            }
 
            public function getContainerRefIDForEditorialStep(): int
            {
                return $this->editorial_ref_id;
            }
 
            public function getContainerRefIDForPublishing(): int
            {
                return $this->publishing_ref_id;
            }
        };
    }

getStatusRepository()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getStatusRepository ( array  $currently_harvested = [] )

protected

Currently harvested objects are passed as obj_id => href_id.

Definition at line 150 of file PublisherTest.php.

     : StatusRepository {
        return new class ($currently_harvested) extends NullStatusRepository {
            public array $exposed_blocks = [];
            public array $exposed_deletions = [];
            public array $exposed_creations = [];
 
            public function __construct(
                protected array $currently_harvested
            ) {
            }
 
            public function setHarvestingBlocked(int $obj_id, bool $blocked): void
            {
                $this->exposed_blocks[] = [
                    'obj_id' => $obj_id,
                    'blocked' => $blocked
                ];
            }
 
            public function getHarvestRefID(int $obj_id): int
            {
                return $this->currently_harvested[$obj_id];
            }
 
            public function deleteHarvestRefID(int $obj_id): void
            {
                $this->exposed_deletions[] = $obj_id;
            }
 
            public function setHarvestRefID(int $obj_id, int $harvested_ref_id): void
            {
                $this->exposed_creations[] = [
                    'obj_id' => $obj_id,
                    'href_id' => $harvested_ref_id
                ];
            }
        };
    }

getXMLWriter()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::getXMLWriter ( array  $returned_md = [] )

protected

Metadata is passed as array via obj_id => metadata-xml as string.

Definition at line 232 of file PublisherTest.php.

                                                            : SimpleDCXMLWriter
    {
        return new class ($returned_md) extends NullWriter {
            public array $exposed_params = [];
 
            public function __construct(protected array $returned_md)
            {
            }
 
            public function writeSimpleDCMetaData(int $obj_id, int $ref_id, string $type): \DOMDocument
            {
                $this->exposed_params[] = [
                    'obj_id' => $obj_id,
                    'ref_id' => $ref_id,
                    'type' => $type
                ];
 
                $xml = new \DOMDocument();
                $xml->loadXML($this->returned_md[$obj_id]);
                return $xml;
            }
        };
    }

References $ref_id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

testAccept()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testAccept

(

)

Definition at line 611 of file PublisherTest.php.

                                : void
    {
        $md = <<<XML
<?xml version="1.0"?>
<md>metadata</md>
 
XML;
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(456, 789),
            $this->getXMLWriter([123 => $md]),
            $this->getNullAccess()
        );
 
        $publisher->accept(123, 'type');
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 789,
                 'new_ref_id' => 789123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 789123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'identifier' => 'il__type_123',
                 'metadata' => $md
             ]],
            $exposed_repo->exposed_creations
        );
    }

testAcceptWithAlreadyExistingRecord()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testAcceptWithAlreadyExistingRecord

(

)

Definition at line 659 of file PublisherTest.php.

                                                         : void
    {
        $md = <<<XML
<?xml version="1.0"?>
<md>metadata</md>
 
XML;
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(123),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(456, 789),
            $this->getXMLWriter([123 => $md]),
            $this->getNullAccess()
        );
 
        $publisher->accept(123, 'type');
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 789,
                 'new_ref_id' => 789123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 789123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'deleted' => false,
                 'metadata' => $md
             ]],
            $exposed_repo->exposed_updates
        );
    }

testBlock()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testBlock

(

)

Definition at line 261 of file PublisherTest.php.

                               : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->block(123);
 
        $this->assertSame(
            [[
                'obj_id' => 123,
                'blocked' => true
             ]],
            $status_repo->exposed_blocks
        );
    }

testPublish()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testPublish

(

)

Definition at line 301 of file PublisherTest.php.

                                 : void
    {
        $md = <<<XML
<?xml version="1.0"?>
<md>metadata</md>
 
XML;
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $object_handler = $this->getObjectHandler(),
            $export_handler = $this->getExportHandler(),
            $this->getSettings(0, 456),
            $this->getXMLWriter([123 => $md]),
            $this->getNullAccess()
        );
 
        $publisher->publish(123, 'type');
 
        $this->assertSame(
            [[
                'obj_id' => 123,
                'container_ref_id' => 456,
                'new_ref_id' => 456123
            ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 456123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertSame(
            [123],
            $export_handler->exposed_created_exports_obj_ids
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'identifier' => 'il__type_123',
                 'metadata' => $md
             ]],
            $exposed_repo->exposed_creations
        );
    }

testPublishWithAlreadyExistingRecord()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testPublishWithAlreadyExistingRecord

(

)

Definition at line 394 of file PublisherTest.php.

                                                          : void
    {
        $md = <<<XML
<?xml version="1.0"?>
<md>metadata</md>
 
XML;
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(123),
            $status_repo = $this->getStatusRepository(),
            $object_handler = $this->getObjectHandler(),
            $export_handler = $this->getExportHandler(),
            $this->getSettings(0, 456),
            $this->getXMLWriter([123 => $md]),
            $this->getNullAccess()
        );
 
        $publisher->publish(123, 'type');
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 456,
                 'new_ref_id' => 456123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 456123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertSame(
            [123],
            $export_handler->exposed_created_exports_obj_ids
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'deleted' => false,
                 'metadata' => $md
             ]],
            $exposed_repo->exposed_updates
        );
    }

testPublishWithAlreadyExportedObject()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testPublishWithAlreadyExportedObject

(

)

Definition at line 349 of file PublisherTest.php.

                                                          : void
    {
        $md = <<<XML
<?xml version="1.0"?>
<md>metadata</md>
 
XML;
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $object_handler = $this->getObjectHandler(),
            $export_handler = $this->getExportHandler(123),
            $this->getSettings(0, 456),
            $this->getXMLWriter([123 => $md]),
            $this->getNullAccess()
        );
 
        $publisher->publish(123, 'type');
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 456,
                 'new_ref_id' => 456123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 456123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertEmpty($export_handler->exposed_created_exports_obj_ids);
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'identifier' => 'il__type_123',
                 'metadata' => $md
             ]],
            $exposed_repo->exposed_creations
        );
    }

testReject()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testReject

(

)

Definition at line 707 of file PublisherTest.php.

                                : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->reject(123);
 
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertEmpty($status_repo->exposed_blocks);
    }

testRejectWithAutomaticPublishing()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testRejectWithAutomaticPublishing

(

)

Definition at line 754 of file PublisherTest.php.

                                                       : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(0, 0, true),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->reject(123);
 
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'blocked' => true
             ]],
            $status_repo->exposed_blocks
        );
    }

testRejectWithOnlyOneReference()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testRejectWithOnlyOneReference

(

)

Definition at line 732 of file PublisherTest.php.

                                                    : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler([456123]),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->reject(123);
 
        $this->assertEmpty($object_handler->exposed_ref_deletions);
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertEmpty($status_repo->exposed_blocks);
    }

testSubmit()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testSubmit

(

)

Definition at line 544 of file PublisherTest.php.

                                : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $object_handler = $this->getObjectHandler(),
            $export_handler = $this->getExportHandler(),
            $this->getSettings(456),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->submit(123);
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 456,
                 'new_ref_id' => 456123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 456123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertSame(
            [123],
            $export_handler->exposed_created_exports_obj_ids
        );
    }

testSubmitWithAlreadyExportedObject()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testSubmitWithAlreadyExportedObject

(

)

Definition at line 579 of file PublisherTest.php.

                                                         : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $object_handler = $this->getObjectHandler(),
            $export_handler = $this->getExportHandler(123),
            $this->getSettings(456),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->submit(123);
 
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'container_ref_id' => 456,
                 'new_ref_id' => 456123
             ]],
            $object_handler->exposed_ref_creations
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'href_id' => 456123
             ]],
            $status_repo->exposed_creations
        );
        $this->assertEmpty($export_handler->exposed_created_exports_obj_ids);
    }

testUnblock()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testUnblock

(

)

Definition at line 284 of file PublisherTest.php.

                                 : void
    {
        $publisher = new Publisher(
            $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository(),
            $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->unblock(123);
 
        $this->assertSame([['obj_id' => 123, 'blocked' => false]], $status_repo->exposed_blocks);
    }

testWithdraw()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testWithdraw

(

)

Definition at line 442 of file PublisherTest.php.

                                  : void
    {
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->withdraw(123);
 
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'deleted' => true,
                 'metadata' => null
             ]],
            $exposed_repo->exposed_updates
        );
        $this->assertEmpty($status_repo->exposed_blocks);
    }

testWithdrawWithAutomaticPublishing()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testWithdrawWithAutomaticPublishing

(

)

Definition at line 505 of file PublisherTest.php.

                                                         : void
    {
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler(),
            $this->getExportHandler(),
            $this->getSettings(0, 0, true),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->withdraw(123);
 
        $this->assertSame(
            [456123],
            $object_handler->exposed_ref_deletions
        );
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'deleted' => true,
                 'metadata' => null
             ]],
            $exposed_repo->exposed_updates
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'blocked' => true
             ]],
            $status_repo->exposed_blocks
        );
    }

testWithdrawWithOnlyOneReference()

ILIAS\MetaData\OERHarvester\Publisher\PublisherTest::testWithdrawWithOnlyOneReference

(

)

Definition at line 475 of file PublisherTest.php.

                                                      : void
    {
        $publisher = new Publisher(
            $exposed_repo = $this->getExposedRecordRepository(),
            $status_repo = $this->getStatusRepository([123 => 456123]),
            $object_handler = $this->getObjectHandler([456123]),
            $this->getExportHandler(),
            $this->getSettings(),
            $this->getXMLWriter(),
            $this->getNullAccess()
        );
 
        $publisher->withdraw(123);
 
        $this->assertEmpty($object_handler->exposed_ref_deletions);
        $this->assertSame(
            [123],
            $status_repo->exposed_deletions
        );
        $this->assertSame(
            [[
                 'obj_id' => 123,
                 'deleted' => true,
                 'metadata' => null
             ]],
            $exposed_repo->exposed_updates
        );
        $this->assertEmpty($status_repo->exposed_blocks);
    }

---

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

• components/ILIAS/MetaData/tests/OERHarvester/Publisher/PublisherTest.php