-
-
Notifications
You must be signed in to change notification settings - Fork 20
/
Nav.php
485 lines (431 loc) · 13.6 KB
/
Nav.php
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
481
482
483
484
485
<?php
declare(strict_types=1);
namespace Yiisoft\Yii\Bootstrap5;
use JsonException;
use RuntimeException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;
use function is_array;
use function is_string;
/**
* Nav renders a nav HTML component.
*
* For example:
*
* ```php
* if ($user->getId() !== null) {
* $menuItems = [
* [
* 'label' => 'About',
* 'url' => '/about',
* ],
* [
* 'label' => 'Contact',
* 'url' => '/contact',
* ],
* [
* 'label' => 'Logout' . ' ' . '(' . $user->getUsername() . ')',
* 'url' => '/logout'
* ],
* ];
* } else {
* $menuItems = [
* [
* 'label' => 'About',
* 'url' => '/about',
* ],
* [
* 'label' => 'Contact',
* 'url' => '/contact',
* ],
* [
* 'label' => 'Login',
* 'url' => '/login',
* ],
* ];
* }
*
* echo Nav::widget()
* ->currentPath($currentPath)
* ->items($menuItems)
* ->options([
* 'class' => 'navbar-nav float-right ml-auto'
* ]);
*
* Note: Multilevel dropdowns beyond Level 1 are not supported in Bootstrap 3.
* Note: $currentPath it must be injected from each controller to the main controller.
*
* SiteController.php
*
* ```php
*
* public function index(ServerRequestInterface $request): ResponseInterface
* {
* $response = $this->responseFactory->createResponse();
* $currentPath = $request->getUri()->getPath();
* $output = $this->render('index', ['currentPath' => $currentPath]);
* $response->getBody()->write($output);
*
* return $response;
* }
* ```
*
* Controller.php
*
* ```php
* private function renderContent($content, array $parameters = []): string
* {
* $user = $this->user->getIdentity();
* $layout = $this->findLayoutFile($this->layout);
*
* if ($layout !== null) {
* return $this->view->renderFile(
* $layout,
* [
* 'aliases' => $this->aliases,
* 'content' => $content,
* 'user' => $user,
* 'params' => $this->params,
* 'currentPath' => !isset($parameters['currentPath']) ?: $parameters['currentPath']
* ],
* $this
* );
* }
*
* return $content;
* }
* ```
*
* {@see http://getbootstrap.com/components/#dropdowns}
* {@see http://getbootstrap.com/components/#nav}
*/
final class Nav extends Widget
{
private array $items = [];
private bool $encodeLabels = true;
private bool $encodeTags = false;
private bool $activateItems = true;
private bool $activateParents = false;
private ?string $activeClass = null;
private string $currentPath = '';
private string $dropdownClass = Dropdown::class;
private array $options = [];
private array $itemOptions = [];
private array $linkOptions = [];
private array $dropdownOptions = [];
protected function run(): string
{
if (!isset($this->options['id'])) {
$this->options['id'] = "{$this->getId()}-nav";
}
Html::addCssClass($this->options, ['widget' => 'nav']);
return $this->renderItems();
}
/**
* List of items in the nav widget. Each array element represents a single menu item which can be either a string
* or an array with the following structure:
*
* - label: string, required, the nav item label.
* - url: optional, the item's URL. Defaults to "#".
* - visible: bool, optional, whether this menu item is visible. Defaults to true.
* - linkOptions: array, optional, the HTML attributes of the item's link.
* - options: array, optional, the HTML attributes of the item container (LI).
* - active: bool, optional, whether the item should be on active state or not.
* - dropdownOptions: array, optional, the HTML options that will passed to the {@see Dropdown} widget.
* - items: array|string, optional, the configuration array for creating a {@see Dropdown} widget, or a string
* representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus.
* - encode: bool, optional, whether the label will be HTML-encoded. If set, supersedes the $encodeLabels option for
* only this item.
*
* If a menu item is a string, it will be rendered directly without HTML encoding.
*
* @param array $value
*
* @return self
*/
public function items(array $value): self
{
$new = clone $this;
$new->items = $value;
return $new;
}
/**
* When tags Labels HTML should not be encoded.
*
* @return self
*/
public function withoutEncodeLabels(): self
{
$new = clone $this;
$new->encodeLabels = false;
return $new;
}
/**
* Disable activate items according to whether their currentPath.
*
* @return self
*
* {@see isItemActive}
*/
public function withoutActivateItems(): self
{
$new = clone $this;
$new->activateItems = false;
return $new;
}
/**
* Whether to activate parent menu items when one of the corresponding child menu items is active.
*
* @return self
*/
public function activateParents(): self
{
$new = clone $this;
$new->activateParents = true;
return $new;
}
/**
* Additional CSS class for active item. Like "bg-success", "bg-primary" etc
*
* @param string|null $className
*
* @return self
*/
public function activeClass(?string $className): self
{
if ($this->activeClass === $className) {
return $this;
}
$new = clone $this;
$new->activeClass = $className;
return $new;
}
/**
* Allows you to assign the current path of the url from request controller.
*
* @param string $value
*
* @return self
*/
public function currentPath(string $value): self
{
$new = clone $this;
$new->currentPath = $value;
return $new;
}
/**
* Name of a class to use for rendering dropdowns within this widget. Defaults to {@see Dropdown}.
*
* @param string $value
*
* @return self
*/
public function dropdownClass(string $value): self
{
$new = clone $this;
$new->dropdownClass = $value;
return $new;
}
/**
* Options for dropdownClass if not present in current item
*
* {@see Nav::renderDropdown()} for details on how this options will be used
*
* @param array $options
*
* @return self
*/
public function dropdownOptions(array $options): self
{
$new = clone $this;
$new->dropdownOptions = $options;
return $new;
}
/**
* The HTML attributes for the widget container tag. The following special options are recognized.
*
* {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
*
* @param array $value
*
* @return self
*/
public function options(array $value): self
{
$new = clone $this;
$new->options = $value;
return $new;
}
/**
* Options for each item if not present in self
*
* @param array $options
*
* @return self
*/
public function itemOptions(array $options): self
{
$new = clone $this;
$new->itemOptions = $options;
return $new;
}
/**
* Options for each item link if not present in current item
*
* @param array $options
*
* @return self
*/
public function linkOptions(array $options): self
{
$new = clone $this;
$new->linkOptions = $options;
return $new;
}
/**
* Renders widget items.
*
* @throws JsonException|RuntimeException
*
* @return string
*/
private function renderItems(): string
{
$items = [];
foreach ($this->items as $i => $item) {
if (isset($item['visible']) && !$item['visible']) {
continue;
}
$items[] = $this->renderItem($item);
}
return Html::tag('ul', implode("\n", $items), $this->options)
->encode($this->encodeTags)
->render();
}
/**
* Renders a widget's item.
*
* @param array|string $item the item to render.
*
* @throws JsonException|RuntimeException
*
* @return string the rendering result.
*/
private function renderItem($item): string
{
if (is_string($item)) {
return $item;
}
if (!isset($item['label'])) {
throw new RuntimeException("The 'label' option is required.");
}
$encodeLabel = $item['encode'] ?? $this->encodeLabels;
$label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
$options = ArrayHelper::getValue($item, 'options', $this->itemOptions);
$items = ArrayHelper::getValue($item, 'items');
$url = ArrayHelper::getValue($item, 'url', '#');
$linkOptions = ArrayHelper::getValue($item, 'linkOptions', $this->linkOptions);
$disabled = ArrayHelper::getValue($item, 'disabled', false);
$active = $this->isItemActive($item);
if (empty($items)) {
$items = '';
} else {
$linkOptions['data-bs-toggle'] = 'dropdown';
Html::addCssClass($options, ['widget' => 'dropdown']);
Html::addCssClass($linkOptions, ['widget' => 'dropdown-toggle']);
if (is_array($items)) {
$items = $this->isChildActive($items, $active);
$items = $this->renderDropdown($items, $item);
}
}
Html::addCssClass($options, ['nav' => 'nav-item']);
Html::addCssClass($linkOptions, ['linkOptions' => 'nav-link']);
if ($disabled) {
$linkOptions['tabindex'] = '-1';
$linkOptions['aria-disabled'] = 'true';
Html::addCssClass($linkOptions, ['disabled' => 'disabled']);
} elseif ($this->activateItems && $active) {
Html::addCssClass($linkOptions, ['active' => rtrim('active ' . $this->activeClass)]);
}
return Html::tag(
'li',
Html::a($label, $url, $linkOptions)->encode($this->encodeTags) . $items,
$options
)->encode($this->encodeTags)->render();
}
/**
* Renders the given items as a dropdown.
*
* This method is called to create sub-menus.
*
* @param array $items the given items. Please refer to {@see Dropdown::items} for the array structure.
* @param array $parentItem the parent item information. Please refer to {@see items} for the structure of this
* array.
*
* @return string the rendering result.
*/
private function renderDropdown(array $items, array $parentItem): string
{
$dropdownClass = $this->dropdownClass;
$dropdown = $dropdownClass::widget()
->items($items)
->options(ArrayHelper::getValue($parentItem, 'dropdownOptions', $this->dropdownOptions));
if ($this->encodeLabels === false) {
$dropdown->withoutEncodeLabels();
}
return $dropdown->render();
}
/**
* Check to see if a child item is active optionally activating the parent.
*
* @param array $items
* @param bool $active should the parent be active too
*
* @return array
*
* {@see items}
*/
private function isChildActive(array $items, bool &$active): array
{
foreach ($items as $i => $child) {
if ($this->isItemActive($child)) {
ArrayHelper::setValue($items[$i], 'active', true);
if ($this->activateParents) {
$active = true;
}
}
if (is_array($child) && ($childItems = ArrayHelper::getValue($child, 'items')) && is_array($childItems)) {
$activeParent = false;
$items[$i]['items'] = $this->isChildActive($childItems, $activeParent);
if ($activeParent) {
$items[$i]['linkOptions'] ??= [];
Html::addCssClass($items[$i]['linkOptions'], ['active' => 'active']);
$active = true;
}
}
}
return $items;
}
/**
* Checks whether a menu item is active.
*
* This is done by checking if {@see currentPath} match that specified in the `url` option of the menu item. When
* the `url` option of a menu item is specified in terms of an array, its first element is treated as the
* currentPath for the item and the rest of the elements are the associated parameters. Only when its currentPath
* and parameters match {@see currentPath}, respectively, will a menu item be considered active.
*
* @param array|string $item the menu item to be checked
*
* @return bool whether the menu item is active
*/
private function isItemActive($item): bool
{
if (isset($item['active'])) {
return ArrayHelper::getValue($item, 'active', false);
}
return isset($item['url'])
&& $this->currentPath !== '/'
&& $item['url'] === $this->currentPath
&& $this->activateItems;
}
}