-
-
Notifications
You must be signed in to change notification settings - Fork 20
/
Alert.php
186 lines (161 loc) · 4.63 KB
/
Alert.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
<?php
declare(strict_types=1);
namespace Yiisoft\Yii\Bootstrap5;
use JsonException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;
use function array_merge;
/**
* Alert renders an alert bootstrap component.
*
* For example,
*
* ```php
* echo Alert::widget()
* ->options([
* 'class' => 'alert-info',
* ])
* ->body('Say hello...');
* ```
*
* @link https://getbootstrap.com/docs/5.0/components/alerts/
*/
final class Alert extends Widget
{
private string $body = '';
private array $closeButton = [];
private bool $closeButtonEnabled = true;
private bool $encodeTags = false;
private array $options = [];
protected function run(): string
{
if (!isset($this->options['id'])) {
$this->options['id'] = "{$this->getId()}-alert";
}
$this->initOptions();
return Html::div($this->renderBodyEnd(), $this->options)
->encode($this->encodeTags)
->render();
}
/**
* The body content in the alert component. Alert widget will also be treated as the body content, and will be
* rendered before this.
*
* @param string $value
*
* @return self
*/
public function body(string $value): self
{
$new = clone $this;
$new->body = $value;
return $new;
}
/**
* The options for rendering the close button tag.
*
* The close button is displayed in the header of the modal window. Clicking on the button will hide the modal
* window. If {@see closeButtonEnabled} is false, no close button will be rendered.
*
* The following special options are supported:
*
* - tag: string, the tag name of the button. Defaults to 'button'.
* - label: string, the label of the button. Defaults to '×'.
*
* The rest of the options will be rendered as the HTML attributes of the button tag.
*
* Please refer to the [Alert documentation](http://getbootstrap.com/components/#alerts) for the supported HTML
* attributes.
*
* @param array $value
*
* @return self
*/
public function closeButton(array $value): self
{
$new = clone $this;
$new->closeButton = $value;
return $new;
}
/**
* Disable close button.
*
* @return self
*/
public function withoutCloseButton(): self
{
$new = clone $this;
$new->closeButtonEnabled = false;
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;
}
/**
* Renders the alert body and the close button (if any).
*
* @throws JsonException
*
* @return string the rendering result
*/
private function renderBodyEnd(): string
{
return $this->body . "\n" . $this->renderCloseButton() . "\n";
}
/**
* Renders the close button.
*
* @throws JsonException
*
* @return string the rendering result
*/
private function renderCloseButton(): ?string
{
if ($this->closeButtonEnabled === false) {
return null;
}
$tag = ArrayHelper::remove($this->closeButton, 'tag', 'button');
$label = ArrayHelper::remove($this->closeButton, 'label', '');
if ($tag === 'button' && !isset($this->closeButton['type'])) {
$this->closeButton['type'] = 'button';
}
return Html::tag($tag, $label, $this->closeButton)
->encode($this->encodeTags)
->render();
}
/**
* Initializes the widget options.
*
* This method sets the default values for various options.
*/
private function initOptions(): void
{
Html::addCssClass($this->options, ['widget' => 'alert']);
if ($this->closeButtonEnabled !== false) {
$this->closeButton = array_merge(
$this->closeButton,
[
'aria-label' => 'Close',
'data-bs-dismiss' => 'alert',
],
);
Html::addCssclass($this->closeButton, ['buttonOptions' => 'btn-close']);
Html::addCssClass($this->options, ['alert-dismissible' => 'alert-dismissible']);
}
if (!isset($this->options['role'])) {
$this->options['role'] = 'alert';
}
}
}