Test on form implementation. More...

Inheritance diagram for FormTest:

Collaboration diagram for FormTest:

Public Member Functions
	getUIFactory ()

	buildDataFactory ()

	test_getInputs ()

	test_extractPostData ()

	test_withRequest ()

	test_withRequest_respects_keys ()

	test_getData ()

	test_getData_respects_keys ()

	test_getData_faulty ()

	test_withAdditionalTransformation ()

	test_nameInputs_respects_keys ()

	testFormWithoutRequiredField ()

	testFormWithRequiredField ()

Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()

	tearDown ()

	getUIFactory ()

	getTemplateFactory ()

	getResourceRegistry ()

	getLanguage ()

	getJavaScriptBinding ()

	getRefinery ()

	getImagePathResolver ()

	getDataFactory ()

	getDefaultRenderer (JavaScriptBinding $js_binding=null, array $with_stub_renderings=[])

	getDecoratedRenderer (Renderer $default)

	normalizeHTML (string $html)

	assertHTMLEquals (string $expected_html_as_string, string $html_as_string)

Protected Member Functions
	buildFactory ()

	buildInputFactory ()

	buildButtonFactory ()

	buildTransformation (Closure $trafo)

	inputMock ()

Protected Member Functions inherited from ILIAS_UI_TestBase
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...

	brutallyTrimSignals (string $html)
	A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output. More...

Protected Attributes
	$language

array	$inputs

Detailed Description

Test on form implementation.

Definition at line 84 of file FormTest.php.

Member Function Documentation

◆ buildButtonFactory()

FormTest::buildButtonFactory ( )

protected

Definition at line 110 of file FormTest.php.

                                           : I\Button\Factory
    {
        return new I\Button\Factory();
    }

Referenced by getUIFactory().

Here is the caller graph for this function:

◆ buildDataFactory()

FormTest::buildDataFactory ( )

Definition at line 129 of file FormTest.php.

                                      : Data\Factory
    {
        return new Data\Factory();
    }

Referenced by test_getData(), test_getData_faulty(), test_getData_respects_keys(), test_withAdditionalTransformation(), test_withRequest(), and test_withRequest_respects_keys().

Here is the caller graph for this function:

◆ buildFactory()

FormTest::buildFactory ( )

protected

Definition at line 92 of file FormTest.php.

                                     : Input\Container\Form\Factory
    {
        return new Input\Container\Form\Factory($this->buildInputFactory());
    }

References buildInputFactory().

Referenced by test_getInputs(), testFormWithoutRequiredField(), and testFormWithRequiredField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildInputFactory()

FormTest::buildInputFactory ( )

protected

Definition at line 97 of file FormTest.php.

                                          : Input\Field\Factory
    {
        $df = new Data\Factory();
        $this->language = $this->createMock(ilLanguage::class);
        return new Input\Field\Factory(
            $this->createMock(\ILIAS\UI\Implementation\Component\Input\UploadLimitResolver::class),
            new SignalGenerator(),
            $df,
            new Refinery($df, $this->language),
            $this->language
        );
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by buildFactory(), test_extractPostData(), test_getData(), test_getData_faulty(), test_getData_respects_keys(), test_getInputs(), test_nameInputs_respects_keys(), test_withAdditionalTransformation(), test_withRequest(), test_withRequest_respects_keys(), testFormWithoutRequiredField(), and testFormWithRequiredField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTransformation()

FormTest::buildTransformation ( Closure $trafo )

protected

Definition at line 115 of file FormTest.php.

                                                          : Transformation
    {
        $dataFactory = new Data\Factory();
        $language = $this->createMock(ilLanguage::class);
        $refinery = new Refinery($dataFactory, $language);
 
        return $refinery->custom()->transformation($trafo);
    }

References $language, and ILIAS\Repository\$refinery.

Referenced by test_withAdditionalTransformation().

Here is the caller graph for this function:

◆ getUIFactory()

FormTest::getUIFactory ( )

Reimplemented from ILIAS_UI_TestBase.

Definition at line 124 of file FormTest.php.

                                  : NoUIFactory
    {
        return new WithButtonNoUIFactory($this->buildButtonFactory());
    }

References buildButtonFactory().

Here is the call graph for this function:

◆ inputMock()

FormTest::inputMock ( )

protected

Returns: Input\Field\FormInputInternal|mixed|MockObject

Definition at line 428 of file FormTest.php.

    {
        static $no = 1000;
        return $this
            ->getMockBuilder(Input\Field\FormInputInternal::class)
            ->onlyMethods([
                "getName",
                "withDedicatedName",
                "withNameFrom",
                "withInput",
                "getContent",
                "getLabel",
                "withLabel",
                "getByline",
                "withByline",
                "isRequired",
                "withRequired",
                "isDisabled",
                "withDisabled",
                "getValue",
                "withValue",
                "getError",
                "withError",
                "withAdditionalTransformation",
                "getUpdateOnLoadCode",
                "getCanonicalName",
                "withOnLoadCode",
                "withAdditionalOnLoadCode",
                "getOnLoadCode",
                "withOnUpdate",
                "appendOnUpdate",
                "withResetTriggeredSignals",
                "getTriggeredSignals"
            ])
            ->setMockClassName("Mock_InputNo" . ($no++))
            ->getMock();
    }

Referenced by test_getData(), test_getData_faulty(), test_getData_respects_keys(), test_withAdditionalTransformation(), test_withRequest(), and test_withRequest_respects_keys().

Here is the caller graph for this function:

◆ test_extractPostData()

FormTest::test_extractPostData ( )

Definition at line 164 of file FormTest.php.

                                          : void
    {
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->expects($this->once())
            ->method("getParsedBody")
            ->willReturn([]);
        $input_data = $form->_extractRequestData($request);
        $this->assertInstanceOf(InputData::class, $input_data);
    }

References buildInputFactory().

Here is the call graph for this function:

◆ test_getData()

FormTest::test_getData ( )

Definition at line 254 of file FormTest.php.

                                  : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->expects($this->once())
            ->method("getParsedBody")
            ->willReturn([]);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(1));
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_1);
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(2));
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_2);
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs([$input_1, $input_2]);
        $form = $form->withRequest($request);
        $this->assertEquals([1, 2], $form->getData());
    }

References buildDataFactory(), buildInputFactory(), and inputMock().

Here is the call graph for this function:

◆ test_getData_faulty()

FormTest::test_getData_faulty ( )

Definition at line 324 of file FormTest.php.

                                         : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->expects($this->once())
            ->method("getParsedBody")
            ->willReturn([]);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->error("error"));
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_1);
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(2));
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_2);
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs(["foo" => $input_1, "bar" => $input_2]);
 
        $i18n = "THERE IS SOME ERROR IN THIS GROUP";
        $this->language
            ->expects($this->once())
            ->method("txt")
            ->with("ui_error_in_group")
            ->willReturn($i18n);
 
        //Todo: This is not good, this should throw an error or similar.
        $form = $form->withRequest($request);
        $this->assertEquals(null, null);
    }

References buildDataFactory(), buildInputFactory(), inputMock(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ test_getData_respects_keys()

FormTest::test_getData_respects_keys ( )

Definition at line 289 of file FormTest.php.

                                                : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->expects($this->once())
            ->method("getParsedBody")
            ->willReturn([]);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(1));
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_1);
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(2));
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_2);
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs(["foo" => $input_1, "bar" => $input_2]);
        $form = $form->withRequest($request);
        $this->assertEquals(["foo" => 1, "bar" => 2], $form->getData());
    }

References buildDataFactory(), buildInputFactory(), and inputMock().

Here is the call graph for this function:

◆ test_getInputs()

FormTest::test_getInputs ( )

Definition at line 134 of file FormTest.php.

                                    : void
    {
        $this->buildFactory();
        $if = $this->buildInputFactory();
        $name_source = new FixedNameSource();
 
        $inputs = [$if->text(""), $if->text("")];
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), $inputs);
 
        $seen_names = [];
        $form_inputs = $form->getInputs();
        $this->assertSameSize($inputs, $form_inputs);
 
        foreach ($form_inputs as $input) {
            $name = $input->getName();
            $name_source->name = $name;
 
            // name is a string
            $this->assertIsString($name);
 
            // only name is attached
            $input = array_shift($form_inputs);
            $this->assertEquals($input->withNameFrom($name_source), $input);
 
            // every name can only be contained once.
            $this->assertNotContains($name, $seen_names);
            $seen_names[] = $name;
        }
    }

References $inputs, $name, buildFactory(), and buildInputFactory().

Here is the call graph for this function:

◆ test_nameInputs_respects_keys()

FormTest::test_nameInputs_respects_keys ( )

Definition at line 410 of file FormTest.php.

                                                   : void
    {
        $if = $this->buildInputFactory();
        $inputs = [
            2 => $if->text(""),
            "foo" => $if->text(""),
            1 => $if->text(""),
            $if->text(""),
        ];
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs($inputs);
        $named_inputs = $form->getInputs();
        $this->assertEquals(array_keys($inputs), array_keys($named_inputs));
    }

References $inputs, and buildInputFactory().

Here is the call graph for this function:

◆ test_withAdditionalTransformation()

FormTest::test_withAdditionalTransformation ( )

Definition at line 368 of file FormTest.php.

                                                       : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->expects($this->once())
            ->method("getParsedBody")
            ->willReturn([]);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(1));
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_1);
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(2));
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->willReturn($input_2);
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs([$input_1, $input_2]);
 
        $form2 = $form->withAdditionalTransformation($this->buildTransformation(function () {
            return "transformed";
        }));
 
        $this->assertNotSame($form2, $form);
        $form2 = $form2->withRequest($request);
 
        $this->assertEquals("transformed", $form2->getData());
    }

References buildDataFactory(), buildInputFactory(), buildTransformation(), and inputMock().

Here is the call graph for this function:

◆ test_withRequest()

FormTest::test_withRequest ( )

Definition at line 176 of file FormTest.php.

                                      : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $input_data = $this->createMock(InputData::class);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->with($input_data)
            ->willReturn($input_1);
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(0));
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->with($input_data)
            ->willReturn($input_2);
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(0));
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs([$input_1, $input_2]);
        $form->input_data = $input_data;
 
        $form2 = $form->withRequest($request);
 
        $this->assertNotSame($form2, $form);
        $this->assertInstanceOf(Form::class, $form2);
        $this->assertEquals([$input_1, $input_2], $form2->getInputs());
    }

References buildDataFactory(), buildInputFactory(), and inputMock().

Here is the call graph for this function:

◆ test_withRequest_respects_keys()

FormTest::test_withRequest_respects_keys ( )

Definition at line 215 of file FormTest.php.

                                                    : void
    {
        $df = $this->buildDataFactory();
        $request = $this->createMock(ServerRequestInterface::class);
        $input_data = $this->createMock(InputData::class);
 
        $input_1 = $this->inputMock();
        $input_1
            ->expects($this->once())
            ->method("withInput")
            ->with($input_data)
            ->willReturn($input_1);
        $input_1
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(0));
 
        $input_2 = $this->inputMock();
        $input_2
            ->expects($this->once())
            ->method("withInput")
            ->with($input_data)
            ->willReturn($input_2);
        $input_2
            ->expects($this->once())
            ->method("getContent")
            ->willReturn($df->ok(0));
 
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), []);
        $form->setInputs(["foo" => $input_1, "bar" => $input_2]);
        $form->input_data = $input_data;
 
        $form2 = $form->withRequest($request);
 
        $this->assertNotSame($form2, $form);
        $this->assertInstanceOf(Form::class, $form2);
        $this->assertEquals(["foo" => $input_1, "bar" => $input_2], $form2->getInputs());
    }

References buildDataFactory(), buildInputFactory(), and inputMock().

Here is the call graph for this function:

◆ testFormWithoutRequiredField()

FormTest::testFormWithoutRequiredField ( )

Definition at line 466 of file FormTest.php.

                                                  : void
    {
        $f = $this->buildFactory();
        $if = $this->buildInputFactory();
        $inputs = [$if->text(""), $if->text("")];
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), $inputs);
 
        $this->assertFalse($form->hasRequiredInputs());
    }

References Vendor\Package\$f, $inputs, buildFactory(), and buildInputFactory().

Here is the call graph for this function:

◆ testFormWithRequiredField()

FormTest::testFormWithRequiredField ( )

Definition at line 476 of file FormTest.php.

                                               : void
    {
        $f = $this->buildFactory();
        $if = $this->buildInputFactory();
        $inputs = [
            $if->text("")->withRequired(true),
            $if->text("")
        ];
        $form = new ConcreteForm($this->buildInputFactory(), new DefNamesource(), $inputs);
        $this->assertTrue($form->hasRequiredInputs());
    }

References Vendor\Package\$f, $inputs, buildFactory(), and buildInputFactory().

Here is the call graph for this function:

Field Documentation

◆ $inputs

array FormTest::$inputs

protected

Definition at line 90 of file FormTest.php.

Referenced by test_getInputs(), test_nameInputs_respects_keys(), testFormWithoutRequiredField(), and testFormWithRequiredField().

◆ $language

FormTest::$language

protected

Definition at line 89 of file FormTest.php.

Referenced by buildTransformation().

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

tests/UI/Component/Input/Container/Form/FormTest.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ buildButtonFactory()

◆ buildDataFactory()

◆ buildFactory()

◆ buildInputFactory()

◆ buildTransformation()

◆ getUIFactory()

◆ inputMock()

◆ test_extractPostData()

◆ test_getData()

◆ test_getData_faulty()

◆ test_getData_respects_keys()

◆ test_getInputs()

◆ test_nameInputs_respects_keys()

◆ test_withAdditionalTransformation()

◆ test_withRequest()

◆ test_withRequest_respects_keys()

◆ testFormWithoutRequiredField()

◆ testFormWithRequiredField()

Field Documentation

◆ $inputs

◆ $language