-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
480 lines (414 loc) · 20.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
<html lang="pl">
<head>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
<script charset="UTF-8" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.0/languages/php.min.js"></script>
<title>DataGrid</title>
<style>
.example {
padding-left: 25px;
padding-right: 25px;
border: 1px dotted gray;
padding-top: 25px;
border-radius: 5px;
margin-bottom: 10px;
}
</style>
</head>
<body>
<div class="container">
<h1 class="mt-5">
DataGrid
</h1>
<p class="lead">
Celem zadania będzie stworzenie biblioteki, która pozwoli na łatwe formatowanie i renderowanie tabel z danymi.
Elementem wejściowym będą surowe dane w postaci tablicy PHP, a wyjściowym kod HTML korzystający z klas
frameworka CSS Boostrap.
</p>
<h3>Co będzie potrzebne?</h3>
<ul>
<li>PHP 7.3 lub 7.4</li>
<li>Znajomość PHP i HTML</li>
<li>
Podstawowa znajomość frameworka CSS
<a href="https://getbootstrap.com/" target="_blank">
Boostrap 4
</a>
</li>
<li>
<a href="https://www.php-fig.org/psr/psr-12" target="_blank">Znajomośc PSR-12: Extended Coding Style</a>
</li>
<li>
Znajomość zasad pisania czystego kodu -
<a href="https://helion.pl/ksiazki/czysty-kod-podrecznik-dobrego-programisty-robert-c-martin,czykov.htm#format/d" target="_blank">
Robert C. Martin, Czysty kod. Podręcznik dobrego programisty
</a>
</li>
<li>
<a href="https://sniacnajavie.pl/solid-kiss-dry-zasady-programowania/" target="_blank">
Znajomośc uniwersalnych zasad programowania - SOLID, KISS, DRY
</a>
</li>
</ul>
<h3>Zwiększ poziom trudności</h3>
<p>
Jeżeli czujesz się na siłach, możesz zwiększyć poziom trudności i dołożyć jeszcze kilka warunków:
</p>
<ul>
<li>
<a href="https://rafalstepien.com/czym-niezmiennosc-immutability-obiektow-warto-niej-korzystac/" target="_blank">
Wszystkie stworzone obiekty w bibliotece zrób Immutable
</a>
</li>
<li>
<a href="https://sarvendev.com/2017/10/kompozycja-ponad-dziedziczenie/" target="_blank">
Zamiast dziediczenia użyj kompozycji
</a>
</li>
<li>
<a href="https://phpunit.de/" target="_blank">
Napisz testy jednostkowe przy pomocy PHPUnit
</a>
</li>
<li>
<a href="https://docs.docker.com/get-started/" target="_blank">
Użyj docker i docker-compose w celu "zadockeryzowania" aplikacji
</a>
</li>
</ul>
<h3>Założenia projektu</h3>
<ul>
<li>
MoneyType ma wspierać waluty: PLN, USD i BHD
</li>
<li>
Przekazanie błędnych danych wejściowych nie może powodować błędów PHP.
</li>
<li>
Użytkownik musi zostać poinformowany, o tym, że DataGrid otrzymał błędne dane.
</li>
<li>
Nagłówki kolumn są klikalne. Kliknięcie nagłówka ma spowodować posortowanie wierszy rosnąco.
Kolejne kliknięcia zmieniają sortowanie na malejące, a następne wyłączają sortowanie.
</li>
<li>
Jeżeli jest użyte sortowanie na jakiejś kolumnie, to obok nazwy kolumny powinna pokazać się jedna z ikon:
<svg class="bi bi-arrow-down-short" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M4.646 7.646a.5.5 0 0 1 .708 0L8 10.293l2.646-2.647a.5.5 0 0 1 .708.708l-3 3a.5.5 0 0 1-.708 0l-3-3a.5.5 0 0 1 0-.708z"/>
<path fill-rule="evenodd" d="M8 4.5a.5.5 0 0 1 .5.5v5a.5.5 0 0 1-1 0V5a.5.5 0 0 1 .5-.5z"/>
</svg>
<svg class="bi bi-arrow-up-short" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8 5.5a.5.5 0 0 1 .5.5v5a.5.5 0 0 1-1 0V6a.5.5 0 0 1 .5-.5z"/>
<path fill-rule="evenodd" d="M7.646 4.646a.5.5 0 0 1 .708 0l3 3a.5.5 0 0 1-.708.708L8 5.707 5.354 8.354a.5.5 0 1 1-.708-.708l3-3z"/>
</svg>
</li>
<li>
Sortowanie ma uwzględniać inną metodę sortowania dla danych liczbowych, a inną dla ciągów znaków.
</li>
<li>
Ilośc wyświetlanych wierszy jest ograniczona do 9 na stronę.
</li>
<li>
Pod tabelą renderuje się paginacja. Klikanie w poszczególne strony pagniacji, powduje przejścia na te strony.
</li>
<li>
Sformatowane dane, powinny używać zamiast zwykłej spacji - non breaking space.
</li>
<li>
Szczególną uwagę należy zwrócić na poprawność działania aplikacji gdy zachodzi połączenie sortowania i pagniacji.
</li>
</ul>
<h3>Zasady dotyczące kodu</h3>
<ul>
<li>
Kod ma być czytelny i ekspresyjny.
</li>
<li>
Silne typowanie powinno być użyte wszędzie gdzie to możliwe.
</li>
<li>
Kod ma być zgodny z PSR-12 i przestrzegać zasad SOLID i DRY.
</li>
<li>
Tam gdzie jest podejrzenie wystąpienia błędu - powinna zostać zrobiona ich obsługa.
</li>
</ul>
<h3>Jak powinno wyglądać ukończone zadanie?</h3>
<p>
Kod źródłowy powinien zostać wrzucony na repozytorium GitHub. Oprócz kodu biblioteki, musi zostać dołączony
plik JSON z danymi, oraz index.php renderujący w pełni działający przykład. Kod powinien używać autoloadera z composera.
</p>
<p>
Jeżeli istnieje taka możliwość, to kod może zostać wrzucony dodatkowo na jakiś serwer.
</p>
<h2>Podstawowy interfejs biblioteki</h2>
<pre>
<code class="php">
<?php
interface DataType
{
/**
* Formatuje dane dla danego typu.
*/
public function format(string $value): string;
}
interface Column
{
/**
* Zmienia tytuł kolumny, który będzie widoczny jako nagłówek.
*/
public function withLabel(string $label): Column;
public function getLabel(): string;
/**
* Ustawia typ danych dla kolumny.
*/
public function withDataType(DataType $type): Column;
public function getDataType(): DataType;
/**
* Ustawienie wyrównania treści znajdujących się w kolumnie.
*/
public function withAlign(string $align): Column;
public function getAlign(): string;
}
interface Config
{
/**
* Dodaje nową kolumną do DataGrid.
*/
public function addColumn(string $key, Column $column): Config;
/**
* Zwraca wszystkie kolumny dla danego DataGrid.
*/
public function getColumns(): array;
}
interface State
{
/**
* Zwraca aktualna strone DataGrid do wyświetlenia
*/
public function getCurrentPage(): int;
/**
* Klucz kolumny, po której będzie sortowany DataGrid.
*/
public function getOrderBy(): string;
/**
* Czy dane mają zostać posortowane malejąco?
*/
public function isOrderDesc(): bool;
/**
* Czy dane mają zostać posortowane rosnąco?
*/
public function isOrderAsc(): bool;
/**
* Zwraca ilośc wierszy które mają zostać wyświetlone na jednej stronie.
*/
public function getRowsPerPage(): int;
}
interface DataGrid
{
/**
* Zmienia aktualną konfigurację DataGrid.
*/
public function withConfig(Config $config): DataGrid;
/**
* Renderuje na ekran kod, który ma za zadanie wyświetlić przygotowany DataGrid.
* Jako parametr przyjmuje: wszystkie dostępne dane, oraz aktualny stan DataGrid w formie obiektu - State.
* Na podstawie State, metoda ma za zadanie posortować wiersze oraz podzielić je na strony.
*/
public function render(array $rows, State $state): void;
}
</code>
</pre>
<h2>Typy danych</h2>
<p>
Każdy z podanych typów danych implementuje interfejs <code>DataType</code>. Wszystkie dodatkowe ustawienia,
takie jak: precyzja, kod waluty, znaki itp. przekzujemy jako parametry konsturktora.
</p>
<p>
<code>TextType</code> - domyślny typ. Renderuje ciąg znaków, jednak przefiltrowany,
tak żeby nie można było wstawić kodu HTML lub JS.
</p>
<p>
<code>NumberType</code> - typ do formatowania wartości liczbowych. Domyślne formatowanie:
tysiące oddzielone spacjami, miejsce dziesiętne przecinkiem, dwa miejsca po przecinku zawsze widoczne.
Możliwość skonfigurowania: dowolnego separatora (tysięcy i miejsca dziesiętnego), precyzji wyświetlania,
metody zaokrąglania, włączenia / wyłączenia stałej ilości miejsc po przecinku.
</p>
<p>
<code>MoneyType</code> - typ do formatowania wartości pieniężnych. Działa podobnie do NumberType,
jednak dodatkowo na końcu wyświetla walutę. Możliwość skonfigurowania: dowolnego separatora
(tysięcy i miejsca dziesiętnego) oraz wyświetlania miejsc dziesiętnych (można wyłączyć aby nie pokazywać groszy).
</p>
<p>
<code>DateTimeType</code> - formatuje date i czas. Możliwość wybrania formatu (zarówno dayt jak i godziny).
</p>
<p>
<code>DateType</code> - formatuje date. Możliwość wyboru formatowania daty.
</p>
<p>
<code>ImageType</code> - wstawia obrazek w znaczniku <code>img</code>. Domyślnie rozmiar obrazka to 16x16 px. Możliwość zmienienia tego rozmiaru.
</p>
<p>
<code>LinkType</code> - Wstawia link do zasobu. Możliwośc wybrania znacznika <code>a</code> lub <code>button</code>,
oraz klasy z Bootstrap 3 w celu zmiany koloru.
</p>
<p>
<code>RawType</code> - Renderuje dokładnie ten sam ciąg znaków co w otrzymanych danych. Służy do wyświetlania HTML.
</p>
<h2>Przykład użycia</h2>
<p>
Data set, który ma zostać wykorzystany w przykładzie do pobrania
<a target="_blank" href="https://pastebin.com/j5KCPctq">tutaj (json)</a>.
</p>
<p>
Użycie biblioteki (index.php):
</p>
<pre>
<code class="php">
<?php
$rows = json_decode(file_get_content("data.json"), true);
$state = HttpState::create(); // instanceof State, dane powinny zostać pobrane z $_GET
$dataGrid = new HtmlDataGrid(); // instanceof DataGrid
$config = (new DefaultConfig) // instanceof Config, z dodatkowymi metodami
->addIntColumn('id')
->addTextColumn('name')
->addIntColumn('age')
->addTextColumn('company')
->addCurrencyColumn('balance', 'USD')
->addTextColumn('phone')
->addTextColumn('email');
echo $dataGrid->withConfig($config)->render($rows, $state);
</code>
</pre>
<p>
Efekt widoczny dla użytkownika:
</p>
<div class="example">
<table class="table table-bordered">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Age</th>
<th>Company</th>
<th>Balance</th>
<th>Phone</th>
<th>Email</th>
</tr>
</thead>
<tbody>
<tr><td style='text-align: right;'>1</td><td>Celina Collins</td><td style='text-align: right;'>23</td><td>NETBOOK</td><td style='text-align: right;'>3 055,76 USD</td><td>+1 (855) 514-2949</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>2</td><td>Brock Adams</td><td style='text-align: right;'>36</td><td>EWAVES</td><td style='text-align: right;'>3 324,40 USD</td><td>+1 (988) 489-3691</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>3</td><td>Augusta Mccarty</td><td style='text-align: right;'>23</td><td>SONGBIRD</td><td style='text-align: right;'>3 266,87 USD</td><td>+1 (987) 470-3284</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>4</td><td>Beasley Rocha</td><td style='text-align: right;'>30</td><td>MARKETOID</td><td style='text-align: right;'>2 670,30 USD</td><td>+1 (845) 429-2442</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>5</td><td>Hayes Peters</td><td style='text-align: right;'>25</td><td>QUILCH</td><td style='text-align: right;'>3 164,32 USD</td><td>+1 (843) 491-2707</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>6</td><td>Cotton Vincent</td><td style='text-align: right;'>34</td><td>NEPTIDE</td><td style='text-align: right;'>3 582,82 USD</td><td>+1 (956) 575-2083</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>7</td><td>Williams Bradshaw</td><td style='text-align: right;'>25</td><td>BOLAX</td><td style='text-align: right;'>3 823,66 USD</td><td>+1 (971) 531-2436</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>8</td><td>Holcomb Chan</td><td style='text-align: right;'>35</td><td>ANIVET</td><td style='text-align: right;'>3 054,39 USD</td><td>+1 (877) 523-3680</td><td>[email protected]</td></tr><tr><td style='text-align: right;'>9</td><td>Mabel Boyd</td><td style='text-align: right;'>31</td><td>ZILLANET</td><td style='text-align: right;'>2 018,92 USD</td><td>+1 (979) 552-3369</td><td>[email protected]</td></tr> </tbody>
</table>
<nav aria-label="Page navigation example">
<ul class="pagination justify-content-center">
<li class="page-item disabled">
<a class="page-link" href="#" tabindex="-1">Previous</a>
</li>
<li class="page-item active"><a class="page-link" href="#">1</a></li>
<li class="page-item"><a class="page-link" href="#">2</a></li>
<li class="page-item"><a class="page-link" href="#">3</a></li>
<li class="page-item"><a class="page-link" href="#">4</a></li>
<li class="page-item">
<a class="page-link" href="#">Next</a>
</li>
</ul>
</nav>
</div>
<h2>Obsługa błędów</h2>
<h4>Błąd krytyczny</h4>
<p>Występje jeżeli dojdzie do jakiegoś błędu, który uniemożliwi działanie biblioteki.</p>
<div class="example">
<div class="alert alert-danger" role="alert">
<svg class="bi bi-exclamation-triangle-fill" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5a.905.905 0 0 0-.9.995l.35 3.507a.552.552 0 0 0 1.1 0l.35-3.507A.905.905 0 0 0 8 5zm.002 6a1 1 0 1 0 0 2 1 1 0 0 0 0-2z"/>
</svg>
Bład krytyczny - ... szczegóły błędu ...
</div>
</div>
<h4>Błąd wiersza</h4>
<p>Występuje kiedy nie ma możliwości wyrenderowania żadnego pola w wierszu.</p>
<div class="example">
<table class="table table-bordered">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Age</th>
<th>Company</th>
<th>Balance</th>
<th>Phone</th>
<th>Email</th>
</tr>
</thead>
<tbody>
<tr><td style='text-align: right;'>1</td><td>Celina Collins</td><td style='text-align: right;'>23</td><td>NETBOOK</td><td style='text-align: right;'>3 055,76 USD</td><td>+1 (855) 514-2949</td><td>[email protected]</td></tr> <tr>
<td colspan="100%" class="text-danger">
<svg class="bi bi-exclamation-triangle-fill" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5a.905.905 0 0 0-.9.995l.35 3.507a.552.552 0 0 0 1.1 0l.35-3.507A.905.905 0 0 0 8 5zm.002 6a1 1 0 1 0 0 2 1 1 0 0 0 0-2z"/>
</svg>
Błąd wiersza - w tym wierszu znajdują się błędne dane
</td>
</tr>
<tr><td style='text-align: right;'>3</td><td>Augusta Mccarty</td><td style='text-align: right;'>23</td><td>SONGBIRD</td><td style='text-align: right;'>3 266,87 USD</td><td>+1 (987) 470-3284</td><td>[email protected]</td></tr> <tr><td style='text-align: right;'>4</td><td>Beasley Rocha</td><td style='text-align: right;'>30</td><td>MARKETOID</td><td style='text-align: right;'>2 670,30 USD</td><td>+1 (845) 429-2442</td><td>[email protected]</td></tr> </tbody>
</table>
<nav aria-label="Page navigation example">
<ul class="pagination justify-content-center">
<li class="page-item disabled">
<a class="page-link" href="#" tabindex="-1">Previous</a>
</li>
<li class="page-item active"><a class="page-link" href="#">1</a></li>
<li class="page-item"><a class="page-link" href="#">2</a></li>
<li class="page-item"><a class="page-link" href="#">3</a></li>
<li class="page-item"><a class="page-link" href="#">4</a></li>
<li class="page-item">
<a class="page-link" href="#">Next</a>
</li>
</ul>
</nav>
</div>
<h4>Błąd komórki</h4>
<p>
Najbardziej pospolity błąd. Występuje jeżeli na podstawie danych przesłanych w wierszu,
nie da się wyrenderować którejś z komórek.
</p>
<div class="example">
<table class="table table-bordered">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
<th>Age</th>
<th>Company</th>
<th>Balance</th>
<th>Phone</th>
<th>Email</th>
</tr>
</thead>
<tbody>
<tr><td style='text-align: right;'>1</td><td>Celina Collins</td><td style='text-align: right;'>23</td><td>NETBOOK</td><td style='text-align: right;'>3 055,76 USD</td><td>+1 (855) 514-2949</td><td>[email protected]</td></tr> <tr><td style='text-align: right;'>2</td><td>Brock Adams</td><td style='text-align: right;'>
<svg class="bi bi-exclamation-triangle-fill" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5a.905.905 0 0 0-.9.995l.35 3.507a.552.552 0 0 0 1.1 0l.35-3.507A.905.905 0 0 0 8 5zm.002 6a1 1 0 1 0 0 2 1 1 0 0 0 0-2z"/>
</svg>
</td><td>EWAVES</td><td style='text-align: right;'>3 324,40 USD</td><td>+1 (988) 489-3691</td><td>[email protected]</td></tr> <tr><td style='text-align: right;'>3</td><td>Augusta Mccarty</td><td style='text-align: right;'>23</td><td>SONGBIRD</td><td style='text-align: right;'>3 266,87 USD</td><td>+1 (987) 470-3284</td><td>[email protected]</td></tr> <tr><td style='text-align: right;'>4</td><td>Beasley Rocha</td><td style='text-align: right;'>30</td><td>MARKETOID</td><td style='text-align: right;'>2 670,30 USD</td><td>+1 (845) 429-2442</td><td>[email protected]</td></tr> </tbody>
</table>
<nav aria-label="Page navigation example">
<ul class="pagination justify-content-center">
<li class="page-item disabled">
<a class="page-link" href="#" tabindex="-1">Previous</a>
</li>
<li class="page-item active"><a class="page-link" href="#">1</a></li>
<li class="page-item"><a class="page-link" href="#">2</a></li>
<li class="page-item"><a class="page-link" href="#">3</a></li>
<li class="page-item"><a class="page-link" href="#">4</a></li>
<li class="page-item">
<a class="page-link" href="#">Next</a>
</li>
</ul>
</nav>
</div>
<script>hljs.initHighlightingOnLoad();</script>
</div>
</body>
</html>