EntityListingTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Implementation\Component\Listing;
use ILIAS\UI\Implementation\Component\Entity;
use ILIAS\UI\Component as I;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\Data\Range;

class EntityListingTest extends ILIAS_UI_TestBase
{
    public function getEntityMapping(): I\Listing\Entity\RecordToEntity
    {
        return new class () implements I\Listing\Entity\RecordToEntity {
            public function map(
                UIFactory $ui_factory,
                mixed $record
            ): Entity\Entity {
                return $ui_factory->entity()->standard('primary', 'secondary');
            }
        };
    }
    public function getUIFactory(): NoUIFactory
    {
        return new class () extends NoUIFactory {
            public function listing(): Listing\Factory
            {
                return new Listing\Factory(
                    new Listing\Workflow\Factory(),
                    new Listing\CharacteristicValue\Factory(),
                    new Listing\Entity\Factory(),
                );
            }
            public function entity(): Entity\Factory
            {
                return new Entity\Factory();
            }
        };
    }

    public function testEntityListingFactory(): void
    {
        $this->assertInstanceOf(
            I\Listing\Entity\EntityListing::class,
            $this->getUIFactory()->listing()->entity()->standard($this->getEntityMapping())
        );
    }

    public function testEntityListingYieldingEntities(): void
    {
        $data = new class () implements I\Listing\Entity\DataRetrieval {
            protected $data = [1,2,3];

            public function getEntities(
                I\Listing\Entity\Mapping $mapping,
                ?Range $range,
                ?array $additional_parameters
            ): \Generator {
                foreach ($this->data as $entry) {
                    yield $mapping->map($entry);
                }
            }
        };

        $listing = $this->getUIFactory()->listing()->entity()
            ->standard($this->getEntityMapping())
            ->withData($data);

        $entities = iterator_to_array($listing->getEntities($this->getUIFactory()));

        $this->assertCount(3, $entities);

        $this->assertInstanceOf(I\Entity\Entity::class, array_pop($entities));
    }
}