EntityTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Implementation\Component\Entity;
use ILIAS\UI\Implementation\Component\Symbol;
use ILIAS\UI\Implementation\Component\Button;
use ILIAS\UI\Implementation\Component\Link;
use ILIAS\UI\Implementation\Component\Image;
use ILIAS\UI\Implementation\Component\Dropdown;
use ILIAS\UI\Implementation\Component\Legacy\Content;
use ILIAS\UI\Implementation\Component\SignalGenerator;
use ILIAS\UI\Component as I;
use ILIAS\UI\Factory as UIFactory;

class EntityTest extends ILIAS_UI_TestBase
{
    protected function getEntityFactory(): Entity\Factory
    {
        return new Entity\Factory();
    }

    protected function legacy(string $string): Content
    {
        return new Content($string, (new SignalGenerator()));
    }

    public function testEntityFactory(): void
    {
        $entity = $this->getEntityFactory()->standard('primary', 'secondary');
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Entity\\Standard", $entity);
        $this->assertEquals('primary', $entity->getPrimaryIdentifier());
        $this->assertEquals('secondary', $entity->getSecondaryIdentifier());
    }

    public function testEntityBasicProperties(): void
    {
        $entity = $this->getEntityFactory()->standard('primary', 'secondary');
        $this->assertEquals([$this->legacy('bc')], $entity->withBlockingAvailabilityConditions($this->legacy('bc'))->getBlockingAvailabilityConditions());
        $this->assertEquals([$this->legacy('fp')], $entity->withFeaturedProperties($this->legacy('fp'))->getFeaturedProperties());
        $this->assertEquals([$this->legacy('md')], $entity->withMainDetails($this->legacy('md'))->getMainDetails());
        $this->assertEquals([$this->legacy('ps')], $entity->withPersonalStatus($this->legacy('ps'))->getPersonalStatus());
        $this->assertEquals([$this->legacy('a')], $entity->withAvailability($this->legacy('a'))->getAvailability());
        $this->assertEquals([$this->legacy('d')], $entity->withDetails($this->legacy('d'))->getDetails());
    }

    public static function getEntityAllowedIdentiferTypes(): array
    {
        $shy_button = new Button\Shy('the label', '#');
        $shy_link = new Link\Standard('the label', '#');
        $image = new Image\Image(I\Image\Image::STANDARD, 'source', 'alt');
        $icon = new Symbol\Icon\Standard('crs', 'label', 'large', false);
        return [
            [$shy_button],
            [$shy_link],
            [$image],
            [$icon],
            ['some string']
        ];
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getEntityAllowedIdentiferTypes')]
    public function testEntityIdentifiers($identifier): void
    {
        $entity = $this->getEntityFactory()->standard($identifier, $identifier);
        $this->assertEquals($identifier, $entity->getPrimaryIdentifier());
        $this->assertEquals($identifier, $entity->getSecondaryIdentifier());
    }

    public function testEntityActionProperties(): void
    {
        $glyph = new Symbol\Glyph\Glyph('laugh', 'some glyph');
        $tag = new Button\Tag('tag', '#');
        $shy = new Button\Shy('shy', '#');
        $entity = $this->getEntityFactory()->standard('primary', 'secondary')
            ->withPrioritizedReactions($glyph, $tag)
            ->withReactions($glyph, $glyph, $glyph)
            ->withActions($shy);

        $this->assertEquals([$glyph, $tag], $entity->getPrioritizedReactions());
        $this->assertEquals([$glyph,$glyph,$glyph], $entity->getReactions());
        $this->assertEquals([$shy], $entity->getActions());
    }

    public function testEntityComponentProperties(): void
    {
        $glyph = new Symbol\Glyph\Glyph('laugh', 'some glyph');
        $tag = new Button\Tag('tag', '#');
        $shy = new Button\Shy('shy', '#');
        $entity = $this->getEntityFactory()->standard('primary', 'secondary')
            ->withPrioritizedReactions($glyph, $tag)
            ->withReactions($glyph)
            ->withActions($shy);

        $this->assertEquals([$glyph, $tag], $entity->getPrioritizedReactions());
        $this->assertEquals([$glyph], $entity->getReactions());
        $this->assertEquals([$shy], $entity->getActions());
    }


    public function getUIFactory(): NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function dropdown(): Dropdown\Factory
            {
                return new Dropdown\Factory();
            }
        };
    }
    public function testEntityRendering(): void
    {
        $glyph = new Symbol\Glyph\Glyph('laugh', 'some glyph');
        $tag = new Button\Tag('tag', '#');
        $shy = new Button\Shy('shy', '#');
        $entity = $this->getEntityFactory()->standard('primary', 'secondary')
            ->withPrioritizedReactions($glyph, $tag)
            ->withReactions($glyph, $glyph)
            ->withActions($shy, $shy)
            ->withBlockingAvailabilityConditions($this->legacy('bc'))
            ->withFeaturedProperties($this->legacy('fp'))
            ->withMainDetails($this->legacy('md'))
            ->withPersonalStatus($this->legacy('ps'))
            ->withAvailability($this->legacy('a'))
            ->withDetails($this->legacy('d'));

        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($entity));
        $expected = $this->brutallyTrimHTML('
<div class="c-entity __container">
    <div class="c-entity __blocking-conditions">bc</div>
    <div class="c-entity __actions">
        <div class="dropdown" id="id_9">
            <button class="btn btn-default dropdown-toggle" type="button" aria-label="actions" aria-haspopup="true" aria-expanded="false" aria-controls="id_9_menu"><span class="caret"></span></button>
            <ul id="id_9_menu" class="dropdown-menu">
                <li><button class="btn btn-link" data-action="#" id="id_7">shy</button></li>
                <li><button class="btn btn-link" data-action="#" id="id_8">shy</button></li>
            </ul>
        </div>
    </div>
    <div class="c-entity __secondary-identifier --string ">secondary</div>
    <div class="c-entity __primary-identifier">primary</div>
    <div class="c-entity __featured">fp</div>
    <div class="c-entity __personal-status">ps</div>
    <div class="c-entity __main-details">md</div>
    <div class="c-entity __availability">a</div>
    <div class="c-entity __details">d</div>
    <div class="c-entity __reactions">
        <a class="glyph" aria-label="some glyph"><span class="glyphicon il-glyphicon-laugh" aria-hidden="true"></span></a>
        <a class="glyph" aria-label="some glyph"><span class="glyphicon il-glyphicon-laugh" aria-hidden="true"></span></a>
    </div>
    <div class="c-entity __featured-reactions">
        <a class="glyph" aria-label="some glyph"><span class="glyphicon il-glyphicon-laugh" aria-hidden="true"></span></a>
        <button class="btn btn-tag btn-tag-relevance-veryhigh" data-action="#" id="id_10">tag</button>
    </div>
</div>
        ');
        $this->assertEquals($expected, $html);
    }
}