FileInputTest Class Reference

Inheritance diagram for FileInputTest:

Collaboration diagram for FileInputTest:

Public Member Functions
	setUp ()
	test_implements_factory_interface ()
	test_render ()
	test_render_error ()
	test_render_no_byline ()
	test_render_value ()
	test_render_with_metadata ()
	test_render_with_metadata_value ()
	test_render_required ()
	test_render_disabled ()
	getUIFactory ()
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
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...
	buildFactory ()
	buildButtonFactory ()
	buildSymbolFactory ()
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
DefNamesource	$name_source

Private Member Functions
	getUploadHandler (?FileInfoResult $file=null)

Detailed Description

Definition at line 55 of file FileInputTest.php.

Member Function Documentation

brutallyTrimHTML()

FileInputTest::brutallyTrimHTML ( string  $html )

protected

A more radical version of normalizeHTML.

Use if hard to tackle issues occur by asserting due string outputs produce an equal DOM

Reimplemented from ILIAS_UI_TestBase.

Definition at line 64 of file FileInputTest.php.

                                                     : string
    {
        $html = str_replace(" />", "/>", $html);
        return parent::brutallyTrimHTML($html);
    }

Referenced by test_render(), test_render_disabled(), test_render_error(), test_render_no_byline(), test_render_required(), test_render_value(), test_render_with_metadata(), and test_render_with_metadata_value().

Here is the caller graph for this function:

buildButtonFactory()

FileInputTest::buildButtonFactory ( )

protected

Definition at line 501 of file FileInputTest.php.

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

Referenced by getUIFactory().

Here is the caller graph for this function:

buildFactory()

FileInputTest::buildFactory ( )

protected

Definition at line 70 of file FileInputTest.php.

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

Referenced by test_implements_factory_interface(), test_render(), test_render_disabled(), test_render_error(), test_render_no_byline(), test_render_required(), test_render_value(), test_render_with_metadata(), and test_render_with_metadata_value().

Here is the caller graph for this function:

buildSymbolFactory()

FileInputTest::buildSymbolFactory ( )

protected

Definition at line 506 of file FileInputTest.php.

                                           : I\Symbol\Factory
    {
        return new I\Symbol\Factory(
            new I\Symbol\Icon\Factory(),
            new I\Symbol\Glyph\Factory(),
            new I\Symbol\Avatar\Factory()
        );
    }

Referenced by getUIFactory().

Here is the caller graph for this function:

getUIFactory()

FileInputTest::getUIFactory

(

)

Reimplemented from ILIAS_UI_TestBase.

Definition at line 515 of file FileInputTest.php.

                                  : WithButtonAndSymbolButNoUIFactory
    {
        return new WithButtonAndSymbolButNoUIFactory(
            $this->buildButtonFactory(),
            $this->buildSymbolFactory()
        );
    }

References buildButtonFactory(), and buildSymbolFactory().

Here is the call graph for this function:

getUploadHandler()

FileInputTest::getUploadHandler ( ?FileInfoResult  $file = null )

private

@inheritDoc

@inheritDoc

Definition at line 85 of file FileInputTest.php.

                                                                   : Field\UploadHandler
    {
        return new class ($file) implements Field\UploadHandler {
            protected ?FileInfoResult $file;
 
            public function __construct(?FileInfoResult $file)
            {
                $this->file = $file;
            }
 
            public function getFileIdentifierParameterName(): string
            {
                return 'file_id';
            }
 
            public function getUploadURL(): string
            {
                return 'uploadurl';
            }
 
            public function getFileRemovalURL(): string
            {
                return 'removalurl';
            }
 
            public function getExistingFileInfoURL(): string
            {
                return 'infourl';
            }
 
            public function getInfoForExistingFiles(array $file_ids): array
            {
                return [];
            }
 
            public function getInfoResult(string $identifier): ?FileInfoResult
            {
                if (null !== $this->file && $identifier === $this->file->getFileIdentifier()) {
                    return $this->file;
                }
 
                return null;
            }
 
            public function supportsChunkedUploads(): bool
            {
                return false;
            }
        };
    }

References ILIAS\GlobalScreen\Provider\__construct().

Referenced by test_implements_factory_interface(), test_render(), test_render_disabled(), test_render_error(), test_render_no_byline(), test_render_required(), test_render_value(), test_render_with_metadata(), and test_render_with_metadata_value().

Here is the call graph for this function:

Here is the caller graph for this function:

setUp()

FileInputTest::setUp

(

)

Reimplemented from ILIAS_UI_TestBase.

Definition at line 59 of file FileInputTest.php.

                           : void
    {
        $this->name_source = new DefNamesource();
    }

test_implements_factory_interface()

FileInputTest::test_implements_factory_interface

(

)

Definition at line 143 of file FileInputTest.php.

                                                       : void
    {
        $f = $this->buildFactory();
 
        $text = $f->file($this->getUploadHandler(), "label", "byline");
 
        $this->assertInstanceOf(\ILIAS\UI\Component\Input\Container\Form\FormInput::class, $text);
        $this->assertInstanceOf(Field\File::class, $text);
    }

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

Here is the call graph for this function:

test_render()

FileInputTest::test_render

(

)

Definition at line 154 of file FileInputTest.php.

                                 : void
    {
        $f = $this->buildFactory();
        $label = "label";
        $byline = "byline";
        $text = $f->file($this->getUploadHandler(), $label, $byline)->withNameFrom($this->name_source);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($text));
 
        $expected = $this->brutallyTrimHTML('
            <div class="form-group row">
                <label class="control-label col-sm-4 col-md-3 col-lg-2">label</label>
                <div class="col-sm-8 col-md-9 col-lg-10">
                    <div id="id_3" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list"></div>
                        <div class="ui-input-file-input-dropzone">
                            <button class="btn btn-link" data-action="#" id="id_2">select_files_from_computer</button>
                            <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                        </div>
                    </div>
                    <div class="help-block">byline</div>
                </div>
            </div>
        ');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_disabled()

FileInputTest::test_render_disabled

(

)

Definition at line 476 of file FileInputTest.php.

                                          : void
    {
        $f = $this->buildFactory();
        $label = "label";
        $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source)->withDisabled(true);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($text));
 
        $expected = $this->brutallyTrimHTML('
            <div class="form-group row"><label class="control-label col-sm-4 col-md-3 col-lg-2">label</label>
                <div class="col-sm-8 col-md-9 col-lg-10">
                    <div id="id_3" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list"></div>
                        <div class="ui-input-file-input-dropzone">
                            <button class="btn btn-link" data-action="#" id="id_2">select_files_from_computer</button>
                            <span class="ui-input-file-input-error-msg" data-dz-error-msg></span></div>
                    </div>
                </div>
            </div>
        ');
 
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_error()

FileInputTest::test_render_error

(

)

Definition at line 183 of file FileInputTest.php.

                                       : void
    {
        $f = $this->buildFactory();
        $label = "label";
        $byline = "byline";
        $error = "an_error";
        $text = $f->file($this->getUploadHandler(), $label, $byline)->withNameFrom($this->name_source)->withError($error);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($text));
 
        $expected = $this->brutallyTrimHTML('
            <div class="form-group row"><label class="control-label col-sm-4 col-md-3 col-lg-2">label</label>
                <div class="col-sm-8 col-md-9 col-lg-10">
                    <div class="help-block alert alert-danger" aria-describedby="id_3" role="alert">an_error</div>
                    <div id="id_3" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list"></div>
                        <div class="ui-input-file-input-dropzone">
                            <button class="btn btn-link" data-action="#" id="id_2">select_files_from_computer</button>
                            <span class="ui-input-file-input-error-msg" data-dz-error-msg></span></div>
                    </div>
                    <div class="help-block">byline</div>
                </div>
            </div>
        ');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_no_byline()

FileInputTest::test_render_no_byline

(

)

Definition at line 212 of file FileInputTest.php.

                                           : void
    {
        $f = $this->buildFactory();
        $label = "label";
        $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($text));
 
        $expected = $this->brutallyTrimHTML('
            <div class="form-group row"><label class="control-label col-sm-4 col-md-3 col-lg-2">label</label>
                <div class="col-sm-8 col-md-9 col-lg-10">
                    <div id="id_3" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list"></div>
                        <div class="ui-input-file-input-dropzone">
                            <button class="btn btn-link" data-action="#" id="id_2">select_files_from_computer</button>
                            <span class="ui-input-file-input-error-msg" data-dz-error-msg></span></div>
                    </div>
                </div>
            </div>
        ');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_required()

FileInputTest::test_render_required

(

)

Definition at line 451 of file FileInputTest.php.

                                          : void
    {
        $f = $this->buildFactory();
        $label = "label";
        $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source)->withRequired(true);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($text));
 
        $expected = $this->brutallyTrimHTML('
            <div class="form-group row"><label class="control-label col-sm-4 col-md-3 col-lg-2">label<span class="asterisk">*</span></label>
                <div class="col-sm-8 col-md-9 col-lg-10">
                    <div id="id_3" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list"></div>
                        <div class="ui-input-file-input-dropzone">
                            <button class="btn btn-link" data-action="#" id="id_2">select_files_from_computer</button>
                            <span class="ui-input-file-input-error-msg" data-dz-error-msg></span></div>
                    </div>
                </div>
            </div>
        ');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_value()

FileInputTest::test_render_value

(

)

Definition at line 237 of file FileInputTest.php.

                                       : void
    {
        $test_file_id = "test_file_id_1";
        $test_file_name = "test file name 1";
 
        $test_file_info = $this->createMock(FileInfoResult::class);
        $test_file_info->method('getFileIdentifier')->willReturn("test_file_id_1");
        $test_file_info->method('getName')->willReturn("test file name 1");
        $test_file_info->method('getSize')->willReturn(1001);
 
        $file_input = $this->buildFactory()->file(
            $this->getUploadHandler($test_file_info),
            "",
        )->withValue([
            $test_file_id,
        ])->withNameFrom($this->name_source);
 
        $html = $this->brutallyTrimHTML($this->getDefaultRenderer()->render($file_input));
 
        $expected = $this->brutallyTrimHTML('
<div class="form-group row">
        <label class="control-label col-sm-4 col-md-3 col-lg-2"></label>
        <div class="col-sm-8 col-md-9 col-lg-10">
                <div id="id_4" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list">
                                <div class="ui-input-file-input ui-input-dynamic-input">
                                        <div class="ui-input-file-info">
                                                <span data-action="expand"></span>
                                                <span data-action="collapse"></span>
                                                <span data-dz-name>test file name 1</span>
                                                <span data-dz-size>1 KB</span>
                                                <span data-action="remove">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="close">
                                                                <span class="glyphicon glyphicon-remove" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                                        </div>
                                        <div class="ui-input-file-metadata" style="display: none;">
                                                <input id="id_1" type="hidden" name="name_0[input_0][]" value="test_file_id_1"/>
                                        </div>
                                        <div class="ui-input-file-input-progress-container">
                                                <div class="ui-input-file-input-progress-indicator"></div>
                                        </div>
                                </div>
                        </div>
                        <div class="ui-input-file-input-dropzone">
                                <button class="btn btn-link" data-action="#" id="id_3">select_files_from_computer</button>
                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                        </div>
                </div>
        </div>
</div>
        ');
        $this->assertEquals($expected, $html);
    }

References brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_with_metadata()

FileInputTest::test_render_with_metadata

(

)

Definition at line 295 of file FileInputTest.php.

                                               : void
    {
        $factory = $this->buildFactory();
 
        $metadata_input = $factory->text("text_input");
        $file_input = $factory->file(
            ($u = $this->getUploadHandler()),
            "file_input",
            null,
            $metadata_input
        )->withValue([
            [
                $u->getFileIdentifierParameterName() => "file_id",
                ""
            ]
        ])->withNameFrom($this->name_source);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($file_input));
 
        $expected = $this->brutallyTrimHTML('
<div class="form-group row">
        <label class="control-label col-sm-4 col-md-3 col-lg-2">file_input</label>
        <div class="col-sm-8 col-md-9 col-lg-10">
                <div id="id_6" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list">
                                <div class="ui-input-file-input ui-input-dynamic-input">
                                        <div class="ui-input-file-info">
                                                <span data-action="expand">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="expand_content">
                                                                <span class="glyphicon glyphicon-triangle-right" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span data-action="collapse">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="collapse_content">
                                                                <span class="glyphicon glyphicon-triangle-bottom" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span data-dz-name></span>
                                                <span data-dz-size></span>
                                                <span data-action="remove">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="close">
                                                                <span class="glyphicon glyphicon-remove" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                                        </div>
                                        <div class="ui-input-file-metadata" style="display: none;">
                                                <div class="form-group row">
                                                        <label for="id_1" class="control-label col-sm-4 col-md-3 col-lg-2">text_input</label>
                                                        <div class="col-sm-8 col-md-9 col-lg-10">
                                                                <input id="id_1" type="text" name="name_0[input_1][]" class="form-control form-control-sm"/>
                                                        </div>
                                                </div>
                                                <input id="id_2" type="hidden" name="name_0[input_2][]" value="file_id"/>
                                        </div>
                                        <div class="ui-input-file-input-progress-container">
                                                <div class="ui-input-file-input-progress-indicator"></div>
                                        </div>
                                </div>
                        </div>
                        <div class="ui-input-file-input-dropzone">
                                <button class="btn btn-link" data-action="#" id="id_5">select_files_from_computer</button>
                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                        </div>
                </div>
        </div>
</div>
        ');
 
        $this->assertEquals($expected, $html);
    }

References $factory, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

test_render_with_metadata_value()

FileInputTest::test_render_with_metadata_value

(

)

Definition at line 369 of file FileInputTest.php.

                                                     : void
    {
        $test_file_id = "test_file_id_1";
        $test_file_name = "test file name 1";
 
        $test_file_info = $this->createMock(FileInfoResult::class);
        $test_file_info->method('getFileIdentifier')->willReturn("test_file_id_1");
        $test_file_info->method('getName')->willReturn("test file name 1");
        $test_file_info->method('getSize')->willReturn(1000 * 1000 + 1);
 
        $factory = $this->buildFactory();
 
        $metadata_input = $factory->text("text_input");
        $file_input = $factory->file(
            $u = $this->getUploadHandler($test_file_info),
            "file_input",
            null,
            $metadata_input
        )->withValue([
            [
                $u->getFileIdentifierParameterName() => $test_file_id,
                "test",
            ]
        ])->withNameFrom($this->name_source);
 
        $r = $this->getDefaultRenderer();
        $html = $this->brutallyTrimHTML($r->render($file_input));
 
        $expected = $this->brutallyTrimHTML('
<div class="form-group row">
        <label class="control-label col-sm-4 col-md-3 col-lg-2">file_input</label>
        <div class="col-sm-8 col-md-9 col-lg-10">
                <div id="id_6" class="ui-input-file">
                        <div class="ui-input-file-input-list ui-input-dynamic-inputs-list">
                                <div class="ui-input-file-input ui-input-dynamic-input">
                                        <div class="ui-input-file-info">
                                                <span data-action="expand">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="expand_content">
                                                                <span class="glyphicon glyphicon-triangle-right" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span data-action="collapse">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="collapse_content">
                                                                <span class="glyphicon glyphicon-triangle-bottom" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span data-dz-name>test file name 1</span>
                                                <span data-dz-size>1 MB</span>
                                                <span data-action="remove">
                                                        <a tabindex="0" class="glyph" href="#" aria-label="close">
                                                                <span class="glyphicon glyphicon-remove" aria-hidden="true"></span>
                                                        </a>
                                                </span>
                                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                                        </div>
                                        <div class="ui-input-file-metadata" style="display: none;">
                                                <div class="form-group row">
                                                        <label for="id_1" class="control-label col-sm-4 col-md-3 col-lg-2">text_input</label>
                                                        <div class="col-sm-8 col-md-9 col-lg-10">
                                                                <input id="id_1" type="text" value="test" name="name_0[input_1][]" class="form-control form-control-sm"/>
                                                        </div>
                                                </div>
                                                <input id="id_2" type="hidden" name="name_0[input_2][]" value="test_file_id_1"/>
                                        </div>
                                        <div class="ui-input-file-input-progress-container">
                                                <div class="ui-input-file-input-progress-indicator"></div>
                                        </div>
                                </div>
                        </div>
                        <div class="ui-input-file-input-dropzone">
                                <button class="btn btn-link" data-action="#" id="id_5">select_files_from_computer</button>
                                <span class="ui-input-file-input-error-msg" data-dz-error-msg></span>
                        </div>
                </div>
        </div>
</div>
        ');
 
        $this->assertEquals($expected, $html);
    }

References $factory, brutallyTrimHTML(), buildFactory(), ILIAS_UI_TestBase\getDefaultRenderer(), and getUploadHandler().

Here is the call graph for this function:

Field Documentation

$name_source

DefNamesource FileInputTest::$name_source

protected

Definition at line 57 of file FileInputTest.php.

---

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

• tests/UI/Component/Input/Field/FileInputTest.php