ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
•All Data Structures Namespaces Files Functions Variables Modules Pages
FileInputTest.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 2017 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4 
5 require_once(__DIR__ . "/../../../../../libs/composer/vendor/autoload.php");
6 require_once(__DIR__ . "/../../../Base.php");
7 require_once(__DIR__ . "/InputTest.php");
8 
9 use ILIAS\Data;
10 use ILIAS\UI\Component\Input\Field;
11 use ILIAS\UI\Implementation\Component\Input\Field\FieldRendererFactory;
12 use ILIAS\UI\Implementation\Component\SignalGenerator;
13 use ILIAS\UI\Implementation\Component\Symbol\Glyph\GlyphRendererFactory;
14 use ILIAS\UI\Implementation\Render\DefaultRendererFactory;
15 use ILIAS\UI\Implementation\Render\FSLoader;
16 use ILIAS\UI\Implementation\Render\JavaScriptBinding;
17 use ILIAS\UI\Implementation\Render\LoaderCachingWrapper;
18 use ILIAS\UI\Implementation\Render\LoaderResourceRegistryWrapper;
19 
20 class WithSomeButtonNoUIFactory extends NoUIFactory
21 {
22  protected $button_factory;
23 
24 
25  public function __construct($button_factory)
26  {
27  $this->button_factory = $button_factory;
28  }
29 
30 
31  public function button()
32  {
33  return $this->button_factory;
34  }
35 }
36 
37 class FileInputTest extends ILIAS_UI_TestBase
38 {
39  public function setUp() : void
40  {
41  $this->name_source = new DefNamesource();
42  }
43 
44 
45  protected function buildFactory()
46  {
47  $df = new Data\Factory();
48  $language = $this->createMock(\ilLanguage::class);
49 
50  return new ILIAS\UI\Implementation\Component\Input\Field\Factory(
51  new SignalGenerator(),
52  $df,
53  new ILIAS\Refinery\Factory($df, $language),
54  $language
55  );
56  }
57 
58 
59  private function getUploadHandler() : Field\UploadHandler
60  {
61  return new class implements Field\UploadHandler {
62  public function getFileIdentifierParameterName() : string
63  {
64  return 'file_id';
65  }
66 
67 
68  public function getUploadURL() : string
69  {
70  return 'uploadurl';
71  }
72 
73 
74  public function getFileRemovalURL() : string
75  {
76  return 'removalurl';
77  }
78 
79 
83  public function getExistingFileInfoURL() : string
84  {
85  return 'infourl';
86  }
87 
88 
92  public function getInfoForExistingFiles(array $file_ids) : array
93  {
94  return [];
95  }
96  };
97  }
98 
99 
100  public function test_implements_factory_interface()
101  {
102  $f = $this->buildFactory();
103 
104  $text = $f->file($this->getUploadHandler(), "label", "byline");
105 
106  $this->assertInstanceOf(Field\Input::class, $text);
107  $this->assertInstanceOf(Field\File::class, $text);
108  }
109 
110 
111  public function test_render()
112  {
113  $f = $this->buildFactory();
114  $label = "label";
115  $byline = "byline";
116  $name = "name_0";
117  $text = $f->file($this->getUploadHandler(), $label, $byline)->withNameFrom($this->name_source);
118 
119  $r = $this->getDefaultRenderer();
120  $html = $this->normalizeHTML($r->render($text));
121 
122  $expected
123  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label</label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> <div class="help-block">byline</div> </div></div>';
124  $this->assertEquals($expected, $html);
125  }
126 
127 
128  public function test_render_error()
129  {
130  $f = $this->buildFactory();
131  $label = "label";
132  $byline = "byline";
133  $name = "name_0";
134  $error = "an_error";
135  $text = $f->file($this->getUploadHandler(), $label, $byline)->withNameFrom($this->name_source)->withError($error);
136 
137  $r = $this->getDefaultRenderer();
138  $html = $this->normalizeHTML($r->render($text));
139 
140  $expected
141  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label</label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> <div class="help-block">byline</div> <div class="help-block alert alert-danger" role="alert"> <img border="0" src="./templates/default/images/icon_alert.svg" alt="alert" /> an_error </div> </div></div>';
142  $this->assertEquals($expected, $html);
143  }
144 
145 
146  public function test_render_no_byline()
147  {
148  $f = $this->buildFactory();
149  $label = "label";
150  $name = "name_0";
151  $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source);
152 
153  $r = $this->getDefaultRenderer();
154  $html = $this->normalizeHTML($r->render($text));
155 
156  $expected
157  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label</label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> </div></div>';
158  $this->assertEquals($expected, $html);
159  }
160 
161 
162  public function test_render_value()
163  {
164  $f = $this->buildFactory();
165  $label = "label";
166  $value = ["value"];
167  $name = "name_0";
168  $text = $f->file($this->getUploadHandler(), $label)->withValue($value)->withNameFrom($this->name_source);
169 
170  $r = $this->getDefaultRenderer();
171  $html = $this->normalizeHTML($r->render($text));
172 
173  $expected
174  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label</label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> </div></div>';
175  $this->assertEquals($expected, $html);
176  }
177 
178 
179  public function test_render_required()
180  {
181  $f = $this->buildFactory();
182  $label = "label";
183  $name = "name_0";
184  $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source)->withRequired(true);
185 
186  $r = $this->getDefaultRenderer();
187  $html = $this->normalizeHTML($r->render($text));
188 
189  $expected
190  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label<span class="asterisk">*</span></label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> </div></div>';
191  $this->assertEquals($expected, $html);
192  }
193 
194 
195  public function test_render_disabled()
196  {
197  $f = $this->buildFactory();
198  $label = "label";
199  $name = "name_0";
200  $text = $f->file($this->getUploadHandler(), $label)->withNameFrom($this->name_source)->withDisabled(true);
201 
202  $r = $this->getDefaultRenderer();
203  $html = $this->normalizeHTML($r->render($text));
204 
205  $expected
206  = '<div class="form-group row"> <label for="name_0" class="control-label col-sm-3">label</label> <div class="col-sm-9"> <div class="il-input-file" id="id_2"><div class="il-input-file-dropzone"> <button class="btn btn-link" data-action="#" id="id_1">select_files_from_computer</button></div><div class="il-input-file-filelist"> <div class="il-input-file-template dz-preview dz-file-preview" style="display: block; border: 1px solid red" data-file-id=""> <div class="dz-details"> <div class="il-input-file-fileinfo"> <div class="il-input-file-fileinfo-title"><span data-dz-name></span></div> <div data-dz-size class="il-input-file-fileinfo-size"></div> <div class="il-input-file-fileinfo-close"> <button type="button" class="close" data-dz-remove> <span aria-hidden="true">&times;</span> <span class="sr-only">Close</span> </button> </div> </div> <!-- <div class="dz-progress"><span class="dz-upload" data-dz-uploadprogress></span></div>--> <!-- <div class="dz-success-mark"><span>✔</span></div>--> <!-- <div class="dz-error-mark"><span>✘</span></div>--> <div class="dz-error-message il-input-file-error"><span data-dz-errormessage></span></div> </div> </div></div><input class="input-template" type="hidden" name="name_0[]" value="" data-file-id=""></div> </div></div>';
207 
208  $this->assertEquals($expected, $html);
209  }
210 
211  //
212  //
213  //
214 
215  protected function buildButtonFactory()
216  {
217  return new ILIAS\UI\Implementation\Component\Button\Factory;
218  }
219 
220 
221  public function getUIFactory()
222  {
223  return new WithSomeButtonNoUIFactory($this->buildButtonFactory());
224  }
225 
226 
227  public function getDefaultRenderer(JavaScriptBinding $js_binding = null)
228  {
229  $ui_factory = $this->getUIFactory();
230  $tpl_factory = $this->getTemplateFactory();
231  $resource_registry = $this->getResourceRegistry();
232  $lng = $this->getLanguage();
233  if (!$js_binding) {
234  $js_binding = $this->getJavaScriptBinding();
235  }
236 
237  $refinery = $this->getRefinery();
238 
239  $component_renderer_loader
240  = new LoaderCachingWrapper(
241  new LoaderResourceRegistryWrapper(
242  $resource_registry,
243  new FSLoader(
244  new DefaultRendererFactory(
245  $ui_factory,
246  $tpl_factory,
247  $lng,
248  $js_binding,
249  $refinery
250  ),
251  new GlyphRendererFactory(
252  $ui_factory,
253  $tpl_factory,
254  $lng,
255  $js_binding,
256  $refinery
257  ),
258  new FieldRendererFactory(
259  $ui_factory,
260  $tpl_factory,
261  $lng,
262  $js_binding,
263  $refinery
264  )
265  )
266  )
267  );
268 
269  return new TestDefaultRenderer($component_renderer_loader);
270  }
271 }
FileInputTest\test_implements_factory_interface
test_implements_factory_interface()
Definition: FileInputTest.php:100
ILIAS\UI\Implementation\Render\FSLoader
Loads renderers for components from the file system.
Definition: FSLoader.php:20
ILIAS
Class ChatMainBarProvider .
WithSomeButtonNoUIFactory\button
button()
description: purpose: > Buttons trigger interactions that change the system’s or view&#39;s status...
Definition: FileInputTest.php:31
ILIAS\UI\Implementation\Render\LoaderCachingWrapper
Caches renderers loaded by another loader.
Definition: LoaderCachingWrapper.php:12
ILIAS\UI\Implementation\Render\LoaderResourceRegistryWrapper
Registers resources for retreived renderers at a ResourceRegistry.
Definition: LoaderResourceRegistryWrapper.php:12
$name
if($format !==null) $name
Definition: metadata.php:230
ILIAS_UI_TestBase
Provides common functionality for UI tests.
Definition: Base.php:224
$lng
$lng
Definition: save_question_post_data.php:23
WithSomeButtonNoUIFactory\__construct
__construct($button_factory)
Definition: FileInputTest.php:25
ILIAS\Data\Factory
Builds data types.
Definition: Factory.php:19
ILIAS\UI\Implementation\Render\JavaScriptBinding
Provides methods to interface with javascript.
Definition: JavaScriptBinding.php:10
FileInputTest\getDefaultRenderer
getDefaultRenderer(JavaScriptBinding $js_binding=null)
Definition: FileInputTest.php:227