-
-
Notifications
You must be signed in to change notification settings - Fork 37
/
Breadcrumbs.php
237 lines (210 loc) · 6.03 KB
/
Breadcrumbs.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
<?php
/**
* @link https://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/
declare(strict_types=1);
namespace yii\bootstrap5;
use Yii;
use yii\helpers\ArrayHelper;
/**
* This widget represents a Bootstrap 5 component "Breadcrumb". It displays a list of links indicating the
* position of the current page in the whole site hierarchy.
*
* ```php
* echo Breadcrumbs::widget([
* 'links' => [
* [
* 'label' => 'the item label', // required
* 'url' => 'the item URL', // optional, will be processed by `Url::to()`
* 'template' => 'own template of the item', // optional
* ],
* ['label' => 'the label of the active item']
* ],
* 'options' => [...],
* ]);
* ```
* or
* ```php
* echo Breadcrumbs::widget([
* 'links' => [
* 'the item URL' => 'the item label',
* 0 => 'the label of the active item',
* ],
* 'options' => [...],
* ]);
* ```
*
* @see https://getbootstrap.com/docs/5.1/components/breadcrumb/
* @author Alexandr Kozhevnikov <onmotion1@gmail.com>
* @author Simon Karlen <simi.albi@outlook.com>
*/
class Breadcrumbs extends \yii\widgets\Breadcrumbs
{
use BootstrapWidgetTrait;
/**
* {@inheritDoc}
*/
public $tag = 'ol';
/**
* @var array|false the first hyperlink in the breadcrumbs (called home link).
* Please refer to [[links]] on the format of the link.
* If this property is not set, it will default to a link pointing to [[\yii\web\Application::homeUrl]]
* with the label 'Home'. If this property is false, the home link will not be rendered.
*/
public $homeLink = [];
/**
* {@inheritDoc}
*/
public $itemTemplate = "<li class=\"breadcrumb-item\">{link}</li>\n";
/**
* {@inheritDoc}
*/
public $activeItemTemplate = "<li class=\"breadcrumb-item active\" aria-current=\"page\">{link}</li>\n";
/**
* @var array the HTML attributes for the widgets nav container tag.
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
public $navOptions = ['aria' => ['label' => 'breadcrumb']];
/**
* {@inheritDoc}
*/
public function run(): string
{
if (empty($this->links)) {
return '';
}
// Normalize links
$links = [];
foreach ($this->links as $key => $value) {
if (is_array($value)) {
$links[] = $value;
} else {
$links[] = ['label' => $value, 'url' => is_string($key) ? $key : null];
}
}
$this->links = $links;
unset($links);
if ($this->homeLink === []) {
$this->homeLink = null;
}
if (!isset($this->options['id'])) {
$this->options['id'] = "{$this->getId()}-breadcrumb";
}
Html::addCssClass($this->options, ['widget' => 'breadcrumb']);
// parent method not return result
ob_start();
parent::run();
$content = ob_get_clean();
return Html::tag('nav', $content, $this->navOptions);
}
/**
* The template used to render each active item in the breadcrumbs. The token `{link}` will be replaced with the
* actual HTML link for each active item.
*
* @param string $value
*
* @return $this
*/
public function activeItemTemplate(string $value): self
{
$this->activeItemTemplate = $value;
return $this;
}
/**
* Whether to HTML-encode the link labels.
*
* @param bool $value
*
* @return $this
*/
public function encodeLabels(bool $value): self
{
$this->encodeLabels = $value;
return $this;
}
/**
* The first hyperlink in the breadcrumbs (called home link).
*
* Please refer to {@see links} on the format of the link.
*
* If this property is not set, it will default to a link pointing with the label 'Home'. If this property is false,
* the home link will not be rendered.
*
* @param array|false $value
*
* @return $this
*/
public function homeLink($value): self
{
$this->homeLink = $value;
return $this;
}
/**
* The template used to render each inactive item in the breadcrumbs. The token `{link}` will be replaced with the
* actual HTML link for each inactive item.
*
* @param string $value
*
* @return $this
*/
public function itemTemplate(string $value): self
{
$this->itemTemplate = $value;
return $this;
}
/**
* List of links to appear in the breadcrumbs. If this property is empty, the widget will not render anything.
* Each array element represents a single item in the breadcrumbs with the following structure.
*
* @param array $value
*
* @return $this
*/
public function links(array $value): self
{
$this->links = $value;
return $this;
}
/**
* The HTML attributes for the widgets nav container tag.
*
* {@see \yii\helpers\Html::renderTagAttributes()} for details on how attributes are being rendered.
*
* @param array $value
*
* @return $this
*/
public function navOptions(array $value): self
{
$this->navOptions = $value;
return $this;
}
/**
* The HTML attributes for the widget container tag. The following special options are recognized.
*
* {@see \yii\helpers\Html::renderTagAttributes()} for details on how attributes are being rendered.
*
* @param array $value
*
* @return $this
*/
public function options(array $value): self
{
$this->options = $value;
return $this;
}
/**
* The name of the breadcrumb container tag.
*
* @param string $value
*
* @return $this
*/
public function tag(string $value): self
{
$this->tag = $value;
return $this;
}
}