Base.php

Go to the documentation of this file.

<?php

require_once(__DIR__ . '/../../../../vendor/composer/vendor/autoload.php');

require_once(__DIR__ . '/Renderer/ilIndependentTemplate.php');
require_once(__DIR__ . '/../../Language/classes/class.ilLanguage.php');

use ILIAS\UI\Component as C;
use ILIAS\UI\Component\Component as IComponent;
use ILIAS\UI\Implementation\Component as I;
use ILIAS\UI\Implementation\Render\DecoratedRenderer;
use ILIAS\UI\Implementation\Render\TemplateFactory;
use ILIAS\UI\Implementation\Render\ResourceRegistry;
use ILIAS\UI\Implementation\Render\JavaScriptBinding;
use ILIAS\UI\Implementation\Render\DefaultRendererFactory;
use ILIAS\UI\Implementation\DefaultRenderer;
use ILIAS\UI\Implementation\Render;
use ILIAS\UI\Implementation\Component\Symbol\Glyph\GlyphRendererFactory;
use ILIAS\UI\Implementation\Component\Input\Field\FieldRendererFactory;
use ILIAS\UI\Implementation\FactoryInternal;
use ILIAS\UI\Renderer;
use PHPUnit\Framework\TestCase;
use ILIAS\UI\Implementation\Component\SignalGenerator;
use PHPUnit\Framework\MockObject\MockObject;
use ILIAS\UI\Component\Component;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\UI\HelpTextRetriever;
use ILIAS\UI\Help;
use ILIAS\UI\Implementation\Component\Input\UploadLimitResolver;
use ILIAS\UI\Implementation\Component\MessageBox\MessageBoxRendererFactory;
use ILIAS\UI\Implementation\Component\Input\Container\Form\FormRendererFactory;

class ilIndependentTemplateFactory implements TemplateFactory
{
    public function getTemplate(string $path, bool $purge_unfilled_vars, bool $purge_unused_blocks): Render\Template
    {
        return new ilIndependentGlobalTemplate($path, $purge_unfilled_vars, $purge_unused_blocks);
    }
}

class NoUIFactory implements FactoryInternal
{
    public function counter(): I\Counter\Factory
    {
    }
    public function button(): I\Button\Factory
    {
    }
    public function card(): I\Card\Factory
    {
    }
    public function deck(array $cards): I\Deck\Deck
    {
    }
    public function listing(): I\Listing\Factory
    {
    }
    public function image(): I\Image\Factory
    {
    }
    public function legacy(): I\Legacy\Factory
    {
    }
    public function panel(): I\Panel\Factory
    {
    }
    public function modal(): I\Modal\Factory
    {
    }
    public function progress(): I\Progress\Factory
    {
    }
    public function dropzone(): I\Dropzone\Factory
    {
    }
    public function popover(): I\Popover\Factory
    {
    }
    public function divider(): I\Divider\Factory
    {
    }
    public function link(): I\Link\Factory
    {
    }
    public function dropdown(): I\Dropdown\Factory
    {
    }
    public function item(): I\Item\Factory
    {
    }
    public function viewControl(): I\ViewControl\Factory
    {
    }
    public function breadcrumbs(array $crumbs): I\Breadcrumbs\Breadcrumbs
    {
    }
    public function chart(): I\Chart\Factory
    {
    }
    public function input(): I\Input\Factory
    {
    }
    public function table(): I\Table\Factory
    {
    }
    public function messageBox(): I\MessageBox\Factory
    {
    }
    public function layout(): I\Layout\Factory
    {
    }
    public function mainControls(): I\MainControls\Factory
    {
    }
    public function tree(): I\Tree\Factory
    {
    }
    public function menu(): I\Menu\Factory
    {
    }
    public function symbol(): I\Symbol\Factory
    {
    }
    public function toast(): I\Toast\Factory
    {
    }
    public function player(): I\Player\Factory
    {
    }
    public function launcher(): I\Launcher\Factory
    {
    }
    public function helpTopics(string ...$topic): array
    {
    }
    public function entity(): I\Entity\Factory
    {
    }
    public function prompt(): I\Prompt\Factory
    {
    }
}

class LoggingRegistry implements ResourceRegistry
{
    public $resources = array();

    public function register(string $name): void
    {
        $this->resources[] = $name;
    }
}

class LanguageMock extends ilLanguage
{
    public array $requested = array();

    public function __construct()
    {
    }

    public function txt($a_topic, $a_default_lang_fallback_mod = ""): string
    {
        $this->requested[] = $a_topic;
        return $a_topic;
    }

    public function toJS($a_lang_key, ?ilGlobalTemplateInterface $a_tpl = null): void
    {
    }

    public string $lang_module = 'common';

    public function loadLanguageModule(string $a_module): void
    {
    }

    public function getLangKey(): string
    {
        return "en";
    }
}

class LoggingJavaScriptBinding implements JavaScriptBinding
{
    public array $on_load_code = array();
    public array $ids = array();
    private int $count = 0;

    public function createId(): string
    {
        $this->count++;
        $id = "id_" . $this->count;
        $this->ids[] = $id;
        return $id;
    }

    public function addOnLoadCode($code): void
    {
        $this->on_load_code[] = $code;
    }

    public function getOnLoadCodeAsync(): string
    {
        return "";
    }
}

class TestDefaultRenderer extends DefaultRenderer
{
    protected array $with_stub_renderings = [];

    public function __construct(
        Render\Loader $component_renderer_loader,
        JavaScriptBinding $java_script_binding,
        \ILIAS\Language\Language $language,
        array $with_stub_renderings = [],
        protected array $with_additional_contexts = [],
    ) {
        $this->with_stub_renderings = array_map(function ($component) {
            return get_class($component);
        }, $with_stub_renderings);

        array_walk($this->with_additional_contexts, fn(Component $c) => $this->pushContext($c));

        parent::__construct($component_renderer_loader, $java_script_binding, $language);
    }

    public function _getRendererFor(IComponent $component): Render\ComponentRenderer
    {
        return $this->getRendererFor($component);
    }

    public function getRendererFor(IComponent $component): Render\ComponentRenderer
    {
        if (in_array(get_class($component), $this->with_stub_renderings)) {
            return new TestDummyRenderer();
        }
        return parent::getRendererFor($component);
    }

    public function _getContexts(): array
    {
        return $this->getContexts();
    }

    public function getComponentCanonicalNameAttribute(IComponent $component): string
    {
        return str_replace(' ', '-', strtolower($component->getCanonicalName()));
    }
}

class TestDummyRenderer implements Render\ComponentRenderer
{
    public function __construct()
    {
    }

    public function render(ILIAS\UI\Component\Component $component, ILIAS\UI\Renderer $default_renderer): string
    {
        return $component->getCanonicalName();
    }

    public function registerResources(ResourceRegistry $registry): void
    {
        // TODO: Implement registerResources() method.
    }
}

class TestDecoratedRenderer extends DecoratedRenderer
{
    private $manipulate = false;

    public function manipulate(): void
    {
        $this->manipulate = true;
    }

    protected function manipulateRendering($component, Renderer $root): ?string
    {
        if ($this->manipulate) {
            return "This content was manipulated";
        } else {
            return null;
        }
    }
}

class IncrementalSignalGenerator extends SignalGenerator
{
    protected int $id = 0;

    protected function createId(): string
    {
        return 'signal_' . ++$this->id;
    }
}

class SignalGeneratorMock extends SignalGenerator
{
}

class DummyComponent implements IComponent
{
    public function getCanonicalName(): string
    {
        return "DummyComponent";
    }
}

abstract class ILIAS_UI_TestBase extends TestCase
{
    use BaseUITestTrait;
}

trait BaseUITestTrait
{
    public function getUIFactory(): NoUIFactory
    {
        return new NoUIFactory();
    }

    public function getTemplateFactory(): ilIndependentTemplateFactory
    {
        return new ilIndependentTemplateFactory();
    }

    public function getResourceRegistry(): LoggingRegistry
    {
        return new LoggingRegistry();
    }

    public function getLanguage(): LanguageMock
    {
        return new LanguageMock();
    }

    public function getJavaScriptBinding(): LoggingJavaScriptBinding
    {
        return new LoggingJavaScriptBinding();
    }

    public function getRefinery()
    {
        return $this->getMockBuilder(\ILIAS\Refinery\Factory::class)
            ->disableOriginalConstructor()
            ->getMock();
    }

    public function getImagePathResolver(): ilImagePathResolver
    {
        return new ilImagePathResolver();
    }

    public function getDataFactory(): DataFactory
    {
        return $this->createMock(DataFactory::class);
    }

    public function getHelpTextRetriever(): HelpTextRetriever
    {
        return new Help\TextRetriever\Echoing();
    }

    public function getUploadLimitResolver(): UploadLimitResolver
    {
        return $this->createMock(UploadLimitResolver::class);
    }

    public function getDefaultRenderer(
        ?JavaScriptBinding $js_binding = null,
        array $with_stub_renderings = [],
        array $with_additional_contexts = [],
    ): TestDefaultRenderer {
        $ui_factory = $this->getUIFactory();
        $tpl_factory = $this->getTemplateFactory();
        $resource_registry = $this->getResourceRegistry();
        $lng = $this->getLanguage();
        if (!$js_binding) {
            $js_binding = $this->getJavaScriptBinding();
        }

        $image_path_resolver = $this->getImagePathResolver();
        $data_factory = $this->getDataFactory();
        $help_text_retriever = $this->getHelpTextRetriever();

        $component_renderer_loader = new Render\LoaderCachingWrapper(
            new Render\LoaderResourceRegistryWrapper(
                $resource_registry,
                new Render\FSLoader(
                    new DefaultRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $image_path_resolver,
                        $data_factory,
                        $help_text_retriever,
                        $this->getUploadLimitResolver()
                    ),
                    new GlyphRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $image_path_resolver,
                        $data_factory,
                        $help_text_retriever,
                        $this->getUploadLimitResolver()
                    ),
                    new FieldRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $image_path_resolver,
                        $data_factory,
                        $help_text_retriever,
                        $this->getUploadLimitResolver()
                    ),
                    new MessageBoxRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $image_path_resolver,
                        $data_factory,
                        $help_text_retriever,
                        $this->getUploadLimitResolver()
                    ),
                    new FormRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $image_path_resolver,
                        $data_factory,
                        $help_text_retriever,
                        $this->getUploadLimitResolver()
                    )
                )
            )
        );
        return new TestDefaultRenderer($component_renderer_loader, $js_binding, $lng, $with_stub_renderings, $with_additional_contexts);
    }

    public function getDecoratedRenderer(Renderer $default)
    {
        return new TestDecoratedRenderer($default);
    }

    public function normalizeHTML(string $html): string
    {
        return trim(str_replace(["\n", "\r"], "", $html));
    }

    public function assertHTMLEquals(string $expected_html_as_string, string $html_as_string): void
    {
        $html = new DOMDocument();
        $html->formatOutput = true;
        $html->preserveWhiteSpace = false;
        $expected = new DOMDocument();
        $expected->formatOutput = true;
        $expected->preserveWhiteSpace = false;
        $html->loadXML($this->normalizeHTML($html_as_string));
        $expected->loadXML($this->normalizeHTML($expected_html_as_string));
        $this->assertEquals($expected->saveHTML(), $html->saveHTML());
    }

    protected function brutallyTrimHTML(string $html): string
    {
        $html = str_replace(["\n", "\r", "\t"], "", $html);
        $html = preg_replace('# {2,}#', " ", $html);
        $html = preg_replace('/<!--(.|\s)*?-->/', '', $html);
        $html = preg_replace("/>(\s+)</", "><", $html);
        $html = str_replace(" >", ">", $html);
        $html = str_replace(" <", "<", $html);
        return trim($html);
    }

    protected function brutallyTrimSignals(string $html): string
    {
        $html = preg_replace('/il_signal_(\w+)/', "il_signal...", $html);
        return $html;
    }
}