generated from yiisoft/package-template
/
NavBar.php
353 lines (311 loc) · 9.43 KB
/
NavBar.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
<?php
declare(strict_types=1);
namespace Yiisoft\Yii\Bulma;
use InvalidArgumentException;
use JsonException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;
use function strpos;
/**
* The navbar component is a responsive and versatile horizontal navigation bar.
*
* @link https://bulma.io/documentation/components/navbar/
*/
final class NavBar extends Widget
{
private string $brand = '';
private string $brandLabel = '';
private string $brandImage = '';
private string $brandUrl = '/';
private string $toggleIcon = '';
private array $options = [];
private array $brandOptions = [];
private array $brandLabelOptions = [];
private array $brandImageOptions = [];
private array $itemsOptions = [];
private array $menuOptions = [];
private array $toggleOptions = [
'aria-expanded' => 'false',
'aria-label' => 'menu',
'class' => 'navbar-burger',
'role' => 'button',
];
public function begin(): ?string
{
parent::begin();
$this->buildOptions();
$this->renderBrand();
$navOptions = $this->options;
$navTag = ArrayHelper::remove($navOptions, 'tag', 'nav');
if (!is_string($navTag) && !is_bool($navTag) && $navTag !== null) {
throw new InvalidArgumentException('Tag should be either string, bool or null.');
}
return
Html::beginTag($navTag, $navOptions) . "\n" .
$this->brand . "\n" .
Html::beginTag('div', $this->menuOptions) .
Html::beginTag('div', $this->itemsOptions);
}
protected function run(): string
{
$tag = ArrayHelper::remove($this->options, 'tag', 'nav');
if (!is_string($tag) && !is_bool($tag) && $tag !== null) {
throw new InvalidArgumentException('Tag should be either string, bool or null.');
}
return
Html::endTag('div') . "\n" .
Html::endTag('div') . "\n" .
Html::endTag($tag);
}
/**
* Set render brand custom, {@see brandLabel} and {@see brandImage} are not generated.
*
* @param string $value
*
* @return self
*/
public function brand(string $value): self
{
$new = clone $this;
$new->brand = $value;
return $new;
}
/**
* The text of the brand label or empty if it's not used. Note that this is not HTML-encoded.
*
* @param string $value
*
* @return self
*/
public function brandLabel(string $value): self
{
$new = clone $this;
$new->brandLabel = $value;
return $new;
}
/**
* The image of the brand or empty if it's not used.
*
* @param string $value
*
* @return self
*/
public function brandImage(string $value): self
{
$new = clone $this;
$new->brandImage = $value;
return $new;
}
/**
* The URL for the brand's hyperlink tag and will be used for the "href" attribute of the brand link. Default value
* is '/' will be used. You may set it to `null` if you want to have no link at all.
*
* @param string $value
*
* @return self
*/
public function brandUrl(string $value): self
{
$new = clone $this;
$new->brandUrl = $value;
return $new;
}
/**
* Set toggle icon.
*
* @param string $value.
*
* @return self
*/
public function toggleIcon(string $value): self
{
$new = clone $this;
$new->toggleIcon = $value;
return $new;
}
/**
* Options HTML attributes for the tag nav.
*
* @param array $value
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function options(array $value): self
{
$new = clone $this;
$new->options = $value;
return $new;
}
/**
* Options HTML attributes of the tag div brand.
*
* @param array $value default value `navbar-item`.
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function brandOptions(array $value): self
{
$new = clone $this;
$new->brandOptions = $value;
return $new;
}
/**
* Options HTML attributes of the tag div brand label.
*
* @param array $value default value `navbar-item`.
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function brandLabelOptions(array $value): self
{
$new = clone $this;
$new->brandLabelOptions = $value;
return $new;
}
/**
* Options HTML attributes of the tag div brand link.
*
* @param array $value default value `navbar-item`.
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function brandImageOptions(array $value): self
{
$new = clone $this;
$new->brandImageOptions = $value;
return $new;
}
/**
* Options HTML attributes of the tag div items nav, values `navbar-start`, `navbar-end`.
*
* @param array $value default value `navbar-start`.
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function itemsOptions(array $value): self
{
$new = clone $this;
$new->itemsOptions = $value;
return $new;
}
/**
* Options HTML attributes of the tag div nav menu.
*
* @param array $value default value `navbar-menu`.
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function menuOptions(array $value): self
{
$new = clone $this;
$new->menuOptions = $value;
return $new;
}
/**
* The HTML attributes of the navbar toggler button.
*
* @param array $value
*
* @return self
*
* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
*/
public function toggleOptions(array $value): self
{
$new = clone $this;
$new->toggleOptions = $value;
return $new;
}
private function buildOptions(): void
{
$id = '';
if (!isset($this->options['id'])) {
$id = $this->getId();
$this->options['id'] = "{$id}-navbar";
}
$this->options = $this->addOptions($this->options, 'navbar');
$this->brandOptions = $this->addOptions($this->brandOptions, 'navbar-brand');
$this->brandLabelOptions = $this->addOptions($this->brandLabelOptions, 'navbar-item');
$this->brandImageOptions = $this->addOptions($this->brandImageOptions, 'navbar-item');
$this->menuOptions = $this->addOptions($this->menuOptions, 'navbar-menu');
$this->menuOptions['id'] = "{$id}-navbar-Menu";
$this->initItemsOptions();
}
private function initItemsOptions(): void
{
$itemsClass = '';
if (isset($this->itemsOptions['class'])) {
$itemsClass = $this->itemsOptions['class'];
unset($this->itemsOptions['class']);
if (is_array($itemsClass)) {
$itemsClass = implode(' ', $itemsClass);
}
}
/** @var string $itemsClass */
if (strpos($itemsClass, 'navbar-end') === false) {
Html::addCssClass($this->itemsOptions, 'navbar-start');
}
if (!empty($itemsClass)) {
Html::addCssClass($this->itemsOptions, $itemsClass);
}
}
private function renderBrand(): void
{
if ($this->brand === '') {
$this->brand = Html::beginTag('div', $this->brandOptions);
if ($this->brandImage !== '' && $this->brandLabel !== '') {
$this->brand .= Html::tag('span', Html::img($this->brandImage), $this->brandImageOptions);
}
if ($this->brandImage !== '' && $this->brandLabel === '') {
$this->brand .= Html::a(Html::img($this->brandImage), $this->brandUrl, $this->brandImageOptions);
}
if ($this->brandLabel !== '') {
$this->brand .= Html::a($this->brandLabel, $this->brandUrl, $this->brandLabelOptions);
}
$this->brand .= $this->renderToggleButton();
$this->brand .= Html::endTag('div');
}
}
/**
* Renders collapsible toggle button.
*
* @throws JsonException
*
* @return string the rendering toggle button.
*/
private function renderToggleButton(): string
{
return
Html::beginTag('a', $this->toggleOptions) .
$this->renderToggleIcon() .
Html::endTag('a');
}
/**
* Render icon toggle.
*
* @throws JsonException
*
* @return string
*/
private function renderToggleIcon(): string
{
if ($this->toggleIcon === '') {
$this->toggleIcon = Html::tag('span', '', ['aria-hidden' => 'true']) .
Html::tag('span', '', ['aria-hidden' => 'true']) .
Html::tag('span', '', ['aria-hidden' => 'true']);
}
return $this->toggleIcon;
}
}