PCInteractiveImageTest.php

Go to the documentation of this file.

<?php

use PHPUnit\Framework\TestCase;

require_once("./components/ILIAS/MediaObjects/ImageMap/class.ilMapArea.php");

class PCInteractiveImageTest extends COPageTestBase
{
    protected function getMediaObjectMock()
    {
        $media_item = new ilMediaItem();
        $media_item->setWidth("100");
        $media_item->setHeight("50");
        $media_object = $this->getMockBuilder(ilObjMediaObject::class)
                             ->disableOriginalConstructor()
                             ->getMock();
        $media_object->method("getMediaItem")
                  ->willReturnCallback(fn() => $media_item);
        return $media_object;
    }

    protected function getObjectAdapterMock()
    {
        $object_adapter = $this->getMockBuilder(\ILIAS\Repository\Object\ObjectAdapter::class)
                             ->disableOriginalConstructor()
                             ->getMock();
        $object_adapter->method("getTypeForObjId")
                     ->willReturnCallback(fn() => "dummy");
        return $object_adapter;
    }

    public function testConstruction(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $this->assertEquals(
            ilPCInteractiveImage::class,
            get_class($pc)
        );
    }

    public function testCreate(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->create($page, "pg");
        $this->assertXmlEquals(
            '<PageObject HierId="pg"></PageObject>',
            $page->getXMLFromDom()
        );
    }

    public function testCreateAlias(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");

        $expected = <<<EOT
<PageObject HierId="pg"><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testDump(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");

        $expected = <<<EOT
<PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem></InteractiveImage></PageContent>
EOT;

        $this->assertXmlEquals(
            $expected,
            $pc->dumpXML()
        );
    }

    public function testAddContentPopup(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");
        $pc->addContentPopup();

        //echo $page->getXMLFromDom();
        //exit;

        $expected = <<<EOT
<PageObject HierId="pg"><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><ContentPopup Title="" Nr="1"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testGetPopups(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");
        $pc->addContentPopup();
        $page->addHierIDs();
        $popups = $pc->getPopups();

        $expected = [
            0 => [
                "title" => "",
                "nr" => "1",
                "pc_id" => "",
                "hier_id" => "1_1"
            ]
        ];

        $this->assertEquals(
            $expected,
            $popups
        );
    }

    public function testSavePopups(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");
        $pc->addContentPopup();
        $page->addHierIDs();
        $popups = $pc->savePopups(
            [
                "1_1:" => "Test Title"
            ]
        );

        $expected = [
            0 => [
                "title" => "Test Title",
                "nr" => "1",
                "pc_id" => "",
                "hier_id" => "1_1"
            ]
        ];

        $this->assertEquals(
            $expected,
            $pc->getPopups()
        );
    }

    public function testDeletePopup(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = new ilPCInteractiveImage($page);
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");
        $pc->addContentPopup();
        $pc->addContentPopup();
        $page->addHierIDs();
        $popups = $pc->savePopups(
            [
                "1_1:" => "Test Title 1",
                "1_2:" => "Test Title 2"
            ]
        );
        $pc->deletePopup("1_1", "");
        $page->stripHierIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><ContentPopup Title="Test Title 2" Nr="2"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    protected function getInteractiveImageInPage(ilPageObject $page): ilPCInteractiveImage
    {
        $pc = new ilPCInteractiveImage(
            $page,
            null,
            $this->getObjectAdapterMock()
        );
        $pc->setMediaObject($this->getMediaObjectMock());
        $pc->createAlias($page, "pg");
        $page->addHierIDs();
        $page->insertPCIds();
        $pc->setHierId("1");
        $pc->setPCId($page->getPCIdForHierId("1"));
        $pc->setDomNode($pc->getDomNode());
        return $pc;
    }

    public function testAddTriggerArea(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerArea(
            $pc->getStandardAliasItem(),
            IL_AREA_RECT,
            "20,20,200,200",
            "Area Title"
        );
        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/><MapArea Shape="Rect" Coords="20,20,200,200" Id="1"><ExtLink Href="#">Area Title</ExtLink></MapArea></MediaAliasItem><Trigger Type="Area" Title="Area Title" Nr="1" OverlayX="0" OverlayY="0" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testAddTriggerMarker(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker(
        );
        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="0" MarkerY="0" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testGetTriggerNodes(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);
        $pc->addTriggerMarker();
        $page->stripPCIDs();
        $nodes = $pc->getTriggerNodes("1", "");
        $this->assertEquals(
            "Trigger",
            $nodes->item(0)->nodeName
        );
    }

    public function testGetTriggers(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);
        $pc->addTriggerMarker();
        $triggers = $pc->getTriggers();
        $this->assertEquals(
            "Marker",
            $triggers[0]["Type"]
        );
    }

    public function testDeleteTrigger(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerArea(
            $pc->getStandardAliasItem(),
            IL_AREA_RECT,
            "20,20,200,200",
            "Area Title"
        );
        $ma = $pc->getStandardAliasItem();
        $pc->deleteTrigger($ma, "1");

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetOverlays(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerArea(
            $pc->getStandardAliasItem(),
            IL_AREA_RECT,
            "20,20,200,200",
            "Area Title"
        );
        $pc->setTriggerOverlays([
            "1" => "image1.jpg"
        ]);

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/><MapArea Shape="Rect" Coords="20,20,200,200" Id="1"><ExtLink Href="#">Area Title</ExtLink></MapArea></MediaAliasItem><Trigger Type="Area" Title="Area Title" Nr="1" OverlayX="0" OverlayY="0" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200" Overlay="image1.jpg"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerOverlayPositions(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerArea(
            $pc->getStandardAliasItem(),
            IL_AREA_RECT,
            "20,20,200,200",
            "Area Title"
        );
        $pc->setTriggerOverlayPositions([
            "1" => "10,20"
        ]);

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/><MapArea Shape="Rect" Coords="20,20,200,200" Id="1"><ExtLink Href="#">Area Title</ExtLink></MapArea></MediaAliasItem><Trigger Type="Area" Title="Area Title" Nr="1" OverlayX="10" OverlayY="20" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerMarkerPositions(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker();
        $pc->setTriggerMarkerPositions(
            ["1" => "50,100"]
        );

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="50" MarkerY="100" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerPopupPositions(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker();
        $pc->setTriggerPopupPositions(
            ["1" => "40,30"]
        );

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="0" MarkerY="0" PopupX="40" PopupY="30" PopupWidth="150" PopupHeight="200"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerPopupSize(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker();
        $pc->setTriggerPopupSize(
            ["1" => "220,330"]
        );

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="0" MarkerY="0" PopupX="0" PopupY="0" PopupWidth="220" PopupHeight="330"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerPopups(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker();
        $pc->setTriggerPopups(
            ["1" => "1"]
        );

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="0" MarkerY="0" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200" PopupNr="1"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }

    public function testSetTriggerTitles(): void
    {
        $page = $this->getEmptyPageWithDom();
        $pc = $this->getInteractiveImageInPage($page);

        $pc->addTriggerMarker();
        $pc->setTriggerTitles(
            ["1" => "My Title"]
        );

        $page->stripHierIDs();
        $page->stripPCIDs();

        $expected = <<<EOT
<PageObject><PageContent><InteractiveImage><MediaAlias OriginId="il__mob_0"/><MediaAliasItem Purpose="Standard"><Layout HorizontalAlign="Left"/></MediaAliasItem><Trigger Type="Marker" Nr="1" OverlayX="0" OverlayY="0" MarkerX="0" MarkerY="0" PopupX="0" PopupY="0" PopupWidth="150" PopupHeight="200" Title="My Title"/></InteractiveImage></PageContent></PageObject>
EOT;

        $this->assertXmlEquals(
            $expected,
            $page->getXMLFromDom()
        );
    }
}