TreeSelectTest Class Reference

Inheritance diagram for TreeSelectTest:

Collaboration diagram for TreeSelectTest:

Public Member Functions
	getDefaultRenderer (?JavaScriptBinding $js_binding=null, array $with_stub_renderings=[], array $with_additional_contexts=[],)
	getUIFactory ()
	testWithValueForInvalidArguments (mixed $value)
	getInvalidArgumentsForWithValue More...
	testWithValueForValidArguments (string|int|null $value)
	getValidArgumentsForWithValue More...
	testRenderWithValue ()
	testRenderWithDisabled ()
	testRenderWithRequired ()
	testRenderDrilldownMenu ()

Static Public Member Functions
static	getInvalidArgumentsForWithValue ()
static	getValidArgumentsForWithValue ()

Protected Member Functions
	setUp ()
	getMenuFactory ()
	getFieldFactory (?Field\Node\Factory $node_factory=null)
	getNodeRetrieval (array $node_stubs=[], array $leaf_stubs=[])
	getLeafStub (string|int $id='', string $name='')
	getBreadcrumbsStub ()
	getDrilldownStub ()
	getLinkStub ()
	getBulkyStub ()
	createSimpleRenderingStub (string $class_name)

Protected Attributes
Component Button Bulky &MockObject	$bulky_stub
string	$bulky_html
Component Link Standard &MockObject	$link_stub
string	$link_html
Component Menu Drilldown &MockObject	$drilldown_stub
string	$drilldown_html
Component Breadcrumbs Breadcrumbs &MockObject	$breadcrumbs_stub
string	$breadcrumbs_html
Component SignalGeneratorInterface	$signal_generator
Component Menu Factory	$menu_factory

Detailed Description

Author

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 33 of file TreeSelectTest.php.

Member Function Documentation

createSimpleRenderingStub()

TreeSelectTest::createSimpleRenderingStub ( string  $class_name )

protected

Returns

array{0: ILIAS & MockObject, 1: string}

Definition at line 404 of file TreeSelectTest.php.

Referenced by getBreadcrumbsStub(), getBulkyStub(), getDrilldownStub(), and getLinkStub().

                                                                    : array
    {
        $stub = $this->createMock($class_name);
        $html = sha1($class_name);
        $stub->method('getCanonicalName')->willReturn($html);
        $stub->method($this->anything())->willReturnSelf();
        return [$stub, $html];
    }

Here is the caller graph for this function:

getBreadcrumbsStub()

TreeSelectTest::getBreadcrumbsStub ( )

protected

Returns

array{0: Component & MockObject, 1: string}

Definition at line 380 of file TreeSelectTest.php.

References createSimpleRenderingStub().

Referenced by setUp().

                                           : array
    {
        return $this->createSimpleRenderingStub(Component\Breadcrumbs\Breadcrumbs::class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBulkyStub()

TreeSelectTest::getBulkyStub ( )

protected

Returns

array{0: Component & MockObject, 1: string}

Definition at line 398 of file TreeSelectTest.php.

References createSimpleRenderingStub().

Referenced by setUp().

                                     : array
    {
        return $this->createSimpleRenderingStub(Component\Button\Bulky::class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultRenderer()

TreeSelectTest::getDefaultRenderer	(	?JavaScriptBinding	$js_binding = null,
		array	$with_stub_renderings = [],
		array	$with_additional_contexts = []
	)

Definition at line 62 of file TreeSelectTest.php.

Referenced by testRenderDrilldownMenu(), testRenderWithDisabled(), testRenderWithRequired(), and testRenderWithValue().

     : TestDefaultRenderer {
        $with_stub_renderings = array_merge($with_stub_renderings, [
            $this->bulky_stub,
            $this->drilldown_stub,
            $this->breadcrumbs_stub,
        ]);

        return parent::getDefaultRenderer($js_binding, $with_stub_renderings, $with_additional_contexts);
    }

Here is the caller graph for this function:

getDrilldownStub()

TreeSelectTest::getDrilldownStub ( )

protected

Returns

array{0: Component & MockObject, 1: string}

Definition at line 386 of file TreeSelectTest.php.

References createSimpleRenderingStub().

Referenced by setUp().

                                         : array
    {
        return $this->createSimpleRenderingStub(Component\Menu\Drilldown::class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldFactory()

TreeSelectTest::getFieldFactory ( ?Field\Node\Factory  $node_factory = null )

protected

Definition at line 344 of file TreeSelectTest.php.

References ILIAS\UI\Implementation\Component\Input\getDataFactory(), and getLanguage().

Referenced by testRenderDrilldownMenu(), testRenderWithDisabled(), testRenderWithRequired(), testRenderWithValue(), testWithValueForInvalidArguments(), and testWithValueForValidArguments().

                                                                                : Field\Factory
    {
        return new Field\Factory(
            ($node_factory) ?: $this->createMock(Field\Node\Factory::class),
            $this->createMock(Component\Input\UploadLimitResolver::class),
            $this->signal_generator,
            $this->getDataFactory(),
            $this->getRefinery(),
            $this->getLanguage(),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInvalidArgumentsForWithValue()

static TreeSelectTest::getInvalidArgumentsForWithValue ( )

static

Definition at line 316 of file TreeSelectTest.php.

                                                            : array
    {
        return [
            [true],
            [new stdClass()],
            [1.000],
            [[1, 2, 3]],
            [[]],
        ];
    }

getLeafStub()

TreeSelectTest::getLeafStub ( string|int  $id = '', string  $name = ''  )

protected

Returns

array{0: Field & MockObject, 1: string}

Definition at line 369 of file TreeSelectTest.php.

References $id.

Referenced by testRenderDrilldownMenu(), and testRenderWithValue().

                                                                          : array
    {
        $stub = $this->createMock(Field\Node\Leaf::class);
        $html = sha1(Field\Node\Leaf::class);
        $stub->method('getCanonicalName')->willReturn($html);
        $stub->method('getId')->willReturn($id);
        $stub->method('getName')->willReturn($name);
        return [$stub, $html];
    }

Here is the caller graph for this function:

getLinkStub()

TreeSelectTest::getLinkStub ( )

protected

Returns

array{0: Component & MockObject, 1: string}

Definition at line 392 of file TreeSelectTest.php.

References createSimpleRenderingStub().

Referenced by setUp().

                                    : array
    {
        return $this->createSimpleRenderingStub(Component\Link\Standard::class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMenuFactory()

TreeSelectTest::getMenuFactory ( )

protected

Definition at line 339 of file TreeSelectTest.php.

Referenced by testRenderDrilldownMenu().

                                       : Component\Menu\Factory
    {
        return new Component\Menu\Factory($this->signal_generator);
    }

Here is the caller graph for this function:

getNodeRetrieval()

TreeSelectTest::getNodeRetrieval ( array  $node_stubs = [], array  $leaf_stubs = []  )

protected

Parameters

Field

Definition at line 360 of file TreeSelectTest.php.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by testRenderDrilldownMenu(), testRenderWithDisabled(), testRenderWithRequired(), testRenderWithValue(), testWithValueForInvalidArguments(), and testWithValueForValidArguments().

                                                                                       : NodeRetrieval & MockObject
    {
        $node_retrieval = $this->createMock(NodeRetrieval::class);
        $node_retrieval->method('getNodes')->willReturnCallback(static fn() => yield from $node_stubs);
        $node_retrieval->method('getNodesAsLeaf')->willReturnCallback(static fn() => yield from $leaf_stubs);
        return $node_retrieval;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUIFactory()

TreeSelectTest::getUIFactory

(

)

Definition at line 76 of file TreeSelectTest.php.

References $breadcrumbs_stub, $menu_factory, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\UI\examples\Breadcrumbs\breadcrumbs(), ILIAS\Repository\button(), ILIAS\Repository\link(), and ILIAS\Repository\symbol().

                                  : \NoUIFactory
    {
        $icon_factory = $this->createMock(Component\Symbol\Icon\Factory::class);
        $glyph_factory = $this->createMock(Component\Symbol\Glyph\Factory::class);
        $glyph_mock = $this->createMock(Component\Symbol\Glyph\Glyph::class);
        $glyph_factory->method($this->anything())->willReturn($glyph_mock);
        $symbol_factory = $this->createMock(Component\Symbol\Factory::class);
        $symbol_factory->method('icon')->willReturn($icon_factory);

        $button_factory = $this->createMock(Component\Button\Factory::class);
        $button_factory->method('bulky')->willReturn($this->bulky_stub);

        $link_factory = $this->createMock(Component\Link\Factory::class);
        $link_factory->method('standard')->willReturn($this->link_stub);

        $node_factory = $this->createMock(Field\Node\Factory::class);
        $field_factory = $this->createMock(Field\Factory::class);
        $field_factory->method('node')->willReturn($node_factory);
        $input_factory = $this->createMock(Component\Input\Factory::class);
        $input_factory->method('field')->willReturn($field_factory);

        return new class (
            $button_factory,
            $symbol_factory,
            $link_factory,
            $input_factory,
            $this->menu_factory,
            $this->breadcrumbs_stub,
        ) extends \NoUIFactory {
            public function __construct(
                protected Component\Button\Factory $button_factory,
                protected Component\Symbol\Factory $symbol_factory,
                protected Component\Link\Factory $link_factory,
                protected Component\Input\Factory $input_factory,
                protected Component\Menu\Factory $menu_factory,
                protected Component\Breadcrumbs\Breadcrumbs $breadcrumbs,
            ) {
            }
            public function button(): Component\Button\Factory
            {
                return $this->button_factory;
            }
            public function breadcrumbs(array $crumbs): Component\Breadcrumbs\Breadcrumbs
            {
                return $this->breadcrumbs;
            }
            public function symbol(): Component\Symbol\Factory
            {
                return $this->symbol_factory;
            }
            public function link(): Component\Link\Factory
            {
                return $this->link_factory;
            }
            public function input(): Component\Input\Factory
            {
                return $this->input_factory;
            }
            public function menu(): Component\Menu\Factory
            {
                return $this->menu_factory;
            }
        };
    }

Here is the call graph for this function:

getValidArgumentsForWithValue()

static TreeSelectTest::getValidArgumentsForWithValue ( )

static

Definition at line 327 of file TreeSelectTest.php.

References null.

                                                          : array
    {
        return [
            [1],
            [-1],
            ['1'],
            [''],
            [' '],
            [null],
        ];
    }

setUp()

TreeSelectTest::setUp ( )

protected

Definition at line 47 of file TreeSelectTest.php.

References $breadcrumbs_html, $breadcrumbs_stub, $bulky_html, $bulky_stub, $drilldown_html, $drilldown_stub, $link_html, $link_stub, getBreadcrumbsStub(), getBulkyStub(), getDrilldownStub(), and getLinkStub().

                              : void
    {
        [$this->bulky_stub, $this->bulky_html] = $this->getBulkyStub();
        [$this->link_stub, $this->link_html] = $this->getLinkStub();
        [$this->drilldown_stub, $this->drilldown_html] = $this->getDrilldownStub();
        [$this->breadcrumbs_stub, $this->breadcrumbs_html] = $this->getBreadcrumbsStub();

        $this->signal_generator = new IncrementalSignalGenerator();

        $this->menu_factory = $this->createMock(Component\Menu\Factory::class);
        $this->menu_factory->method('drilldown')->willReturn($this->drilldown_stub);

        parent::setUp();
    }

Here is the call graph for this function:

testRenderDrilldownMenu()

TreeSelectTest::testRenderDrilldownMenu

(

)

Definition at line 239 of file TreeSelectTest.php.

References $renderer, ILIAS\Repository\button(), ILIAS\UI\examples\Symbol\Glyph\Close\close(), getDefaultRenderer(), getFieldFactory(), getLeafStub(), getMenuFactory(), getNodeRetrieval(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), null, and ILIAS\Repository\ui().

                                             : void
    {
        $this->menu_factory = $this->getMenuFactory();

        [$leaf_stub, $leaf_html] = $this->getLeafStub();

        $tree_select_label = 'some tree select label';

        $node_retrieval = $this->getNodeRetrieval([$leaf_stub]);

        $component = $this->getFieldFactory()->treeSelect($node_retrieval, $tree_select_label);
        $component = $component->withNameFrom(new DefNamesource());

        $renderer = $this->getDefaultRenderer(null, [$leaf_stub]);

        $expected_html = <<<HTML
<fieldset class="c-input" data-il-ui-component="tree-select-field-input" data-il-ui-input-name="name_0">
    <label for="id_3">some tree select label</label>
    <div class="c-input__field">
        <div class="c-input-tree_select">
            <dialog class="c-modal">
                <div class="modal-dialog" role="document">
                    <div class="modal-content">
                        <div class="modal-header">
                        <button data-action="close" type="button" class="close" aria-label="close">
                            <span aria-hidden="true">&times;</span>
                        </button>
                            <h1 class="modal-title">$tree_select_label</h1>
                        </div>
                        <div class="modal-body">
                            <template>$this->breadcrumbs_html</template>
                            $this->breadcrumbs_html
                            <section class="c-drilldown" id="id_2">
                                <header class="c-drilldown__header--showbacknav">
                                    <div></div>
                                    <div></div>
                                    <div class="c-drilldown__backnav"> $this->bulky_html</div>
                                </header>
                                <div class="c-drilldown__menu">
                                    <ul aria-live="polite" aria-label="$tree_select_label">
                                        $leaf_html
                                        <li class="c-drilldown__menu--no-items"> drilldown_no_items</li>
                                    </ul>
                                </div>
                            </section>
                        </div>
                        <div class="modal-footer">
                            <button data-action="close" type="button" class="btn btn-default" aria-label="close">close</button>
                            <button data-action="close" type="button" class="btn btn-primary" aria-label="select">select</button>
                        </div>
                    </div>
                </div>
            </dialog>
            <ul class="c-input-tree_select__selection">
                <template>
                    <li data-node-id="">
                    <span data-node-name></span>
                    <button data-action="remove" type="button" class="close" aria-label="">
                        <span aria-hidden="true">&times;</span>
                    </button>
                    <input id="id_1" type="hidden" name="name_0[input_0][]" value="" /></li>
                </template>
            </ul>
            <input id="id_3" type="button" aria-label="select" value="select">
        </div>
    </div>
</fieldset>
HTML;

        $actual_html = $renderer->render($component);

        $this->assertEquals(
            $this->brutallyTrimHTML($expected_html),
            $this->brutallyTrimHTML($actual_html),
        );
    }

Here is the call graph for this function:

testRenderWithDisabled()

TreeSelectTest::testRenderWithDisabled

(

)

Definition at line 193 of file TreeSelectTest.php.

References $renderer, ILIAS\UI\examples\Input\Field\Checkbox\disabled(), getDefaultRenderer(), getFieldFactory(), and getNodeRetrieval().

                                            : void
    {
        $node_retrieval = $this->getNodeRetrieval();

        $component = $this->getFieldFactory()->treeSelect($node_retrieval, '');
        $component = $component->withDisabled(true);

        $renderer = $this->getDefaultRenderer();

        $expected_html = <<<HTML
<input id="id_2" type="button" aria-label="select" value="select" disabled>
HTML;

        $actual_html = $renderer->render($component);

        $this->assertTrue(
            str_contains(
                $this->brutallyTrimHTML($actual_html),
                $this->brutallyTrimHTML($expected_html),
            )
        );
    }

Here is the call graph for this function:

testRenderWithRequired()

TreeSelectTest::testRenderWithRequired

(

)

Definition at line 216 of file TreeSelectTest.php.

References $renderer, getDefaultRenderer(), getFieldFactory(), and getNodeRetrieval().

                                            : void
    {
        $node_retrieval = $this->getNodeRetrieval();

        $component = $this->getFieldFactory()->treeSelect($node_retrieval, '');
        $component = $component->withRequired(true);

        $renderer = $this->getDefaultRenderer();

        $expected_html = <<<HTML
<label for="id_2"><span class="asterisk" aria-label="required_field">*</span></label>
HTML;

        $actual_html = $renderer->render($component);

        $this->assertTrue(
            str_contains(
                $this->brutallyTrimHTML($actual_html),
                $this->brutallyTrimHTML($expected_html),
            )
        );
    }

Here is the call graph for this function:

testRenderWithValue()

TreeSelectTest::testRenderWithValue

(

)

Definition at line 159 of file TreeSelectTest.php.

References $renderer, ILIAS\Repository\button(), getDefaultRenderer(), getFieldFactory(), getLeafStub(), getNodeRetrieval(), and null.

                                         : void
    {
        $node_id = 'some-existing-node-id';
        $node_name = 'some existing node';

        [$leaf_stub,] = $this->getLeafStub($node_id, $node_name);

        $node_retrieval = $this->getNodeRetrieval([], [$leaf_stub]);

        $component = $this->getFieldFactory()->treeSelect($node_retrieval, '');
        $component = $component->withValue($node_id);

        $renderer = $this->getDefaultRenderer(null, [$leaf_stub]);

        $expected_html = <<<HTML
<li data-node-id="$node_id">
    <span data-node-name>$node_name</span>
    <button data-action="remove" type="button" class="close" aria-label="unselect_node">
        <span aria-hidden="true">&times;</span>
    </button>
    <input id="id_2" type="hidden" value="$node_id" />
</li>
HTML;

        $actual_html = $renderer->render($component);

        $this->assertTrue(
            str_contains(
                $this->brutallyTrimHTML($actual_html),
                $this->brutallyTrimHTML($expected_html),
            )
        );
    }

Here is the call graph for this function:

testWithValueForInvalidArguments()

TreeSelectTest::testWithValueForInvalidArguments

(

mixed

$value

)

getInvalidArgumentsForWithValue

Definition at line 142 of file TreeSelectTest.php.

References getFieldFactory(), and getNodeRetrieval().

                                                                  : void
    {
        $node_retrieval = $this->getNodeRetrieval();
        $component = $this->getFieldFactory()->treeSelect($node_retrieval, '');
        $this->expectException(InvalidArgumentException::class);
        $component = $component->withValue($value);
    }

Here is the call graph for this function:

testWithValueForValidArguments()

TreeSelectTest::testWithValueForValidArguments

(

string|int|null

$value

)

getValidArgumentsForWithValue

Definition at line 151 of file TreeSelectTest.php.

References getFieldFactory(), and getNodeRetrieval().

                                                                          : void
    {
        $node_retrieval = $this->getNodeRetrieval();
        $component = $this->getFieldFactory()->treeSelect($node_retrieval, '');
        $component = $component->withValue($value);
        $this->assertEquals([$value], $component->getValue());
    }

Here is the call graph for this function:

Field Documentation

$breadcrumbs_html

string TreeSelectTest::$breadcrumbs_html

protected

Definition at line 42 of file TreeSelectTest.php.

Referenced by setUp().

$breadcrumbs_stub

Component Breadcrumbs Breadcrumbs& MockObject TreeSelectTest::$breadcrumbs_stub

protected

Definition at line 41 of file TreeSelectTest.php.

Referenced by getUIFactory(), and setUp().

$bulky_html

string TreeSelectTest::$bulky_html

protected

Definition at line 36 of file TreeSelectTest.php.

Referenced by setUp().

$bulky_stub

Component Button Bulky& MockObject TreeSelectTest::$bulky_stub

protected

Definition at line 35 of file TreeSelectTest.php.

Referenced by setUp().

$drilldown_html

string TreeSelectTest::$drilldown_html

protected

Definition at line 40 of file TreeSelectTest.php.

Referenced by setUp().

$drilldown_stub

Component Menu Drilldown& MockObject TreeSelectTest::$drilldown_stub

protected

Definition at line 39 of file TreeSelectTest.php.

Referenced by setUp().

$link_html

string TreeSelectTest::$link_html

protected

Definition at line 38 of file TreeSelectTest.php.

Referenced by setUp().

$link_stub

Component Link Standard& MockObject TreeSelectTest::$link_stub

protected

Definition at line 37 of file TreeSelectTest.php.

Referenced by setUp().

$menu_factory

Component Menu Factory TreeSelectTest::$menu_factory

protected

Definition at line 45 of file TreeSelectTest.php.

Referenced by getUIFactory().

$signal_generator

Component SignalGeneratorInterface TreeSelectTest::$signal_generator

protected

Definition at line 44 of file TreeSelectTest.php.

---

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

• components/ILIAS/UI/tests/Component/Input/Field/TreeSelectTest.php