-
Notifications
You must be signed in to change notification settings - Fork 146
/
OptionsAwareTrait.php
217 lines (183 loc) · 6.61 KB
/
OptionsAwareTrait.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
<?php
declare(strict_types=1);
namespace BootstrapUI\View\Helper;
use BootstrapUI\View\Helper\Types\Classes;
use BootstrapUI\View\Helper\Types\Element;
trait OptionsAwareTrait
{
/**
* Contains the logic for applying style classes for buttons.
*
* @param array $data An array of HTML attributes and options.
* @return array An array of HTML attributes and options.
*/
public function applyButtonClasses(array $data): array
{
$allClasses = $this->genAllClassNames(Element::BTN);
if ($this->hasAnyClass($allClasses, $data)) {
$data = $this->injectClasses(Element::BTN, $data);
} else {
$data = $this->injectClasses([Element::BTN, Classes::SECONDARY], $data);
}
return $this->renameClasses(Element::BTN, $data);
}
/**
* Renames any CSS classes found in the options.
*
* @param string $element UI element to which the classname is applied.
* @param array $options An array of HTML attributes and options.
* @return array An array of HTML attributes and options.
*/
public function renameClasses(string $element, array $options): array
{
$options += ['class' => []];
$options['class'] = $this->_toClassArray($options['class']);
$classes = [];
foreach ($options['class'] as $name) {
$classes[] = in_array($name, Classes::values())
? $this->genClassName($element, $name)
: $name;
}
$options['class'] = trim(implode(' ', $classes));
return $options;
}
/**
* Checks if `$options['class']` contains any one of the class names.
*
* @param array|string $classes Name of class(es) to check.
* @param array $options An array of HTML attributes and options.
* @return bool True if any one of the class names was found.
*/
public function hasAnyClass(array|string $classes, array $options): bool
{
$options += ['class' => []];
$options['class'] = $this->_toClassArray($options['class']);
$classes = $this->_toClassArray($classes);
foreach ($classes as $class) {
if (in_array($class, $options['class'])) {
return true;
}
}
return false;
}
/**
* Injects classes into `$options['class']` when they don't already exist. If a class is defined
* in `$options['skip']` then it will not be injected. This method removes `$options['skip']` before
* returning.
*
* @param array|string $classes Name of class(es) to inject.
* @param array $options An array of HTML attributes and options.
* @return array An array of HTML attributes and options.
*/
public function injectClasses(array|string $classes, array $options): array
{
$options += ['class' => [], 'skip' => []];
$options['class'] = $this->_toClassArray($options['class']);
$options['skip'] = $this->_toClassArray($options['skip']);
$classes = $this->_toClassArray($classes);
foreach ($classes as $class) {
if (!in_array($class, $options['class']) && !in_array($class, $options['skip'])) {
array_push($options['class'], $class);
}
}
unset($options['skip']);
$options['class'] = trim(implode(' ', $options['class']));
return $options;
}
/**
* Removes classes from `$options['class']`.
*
* @param array|string $classes Name of class(es) to remove.
* @param array $options An array of HTML attributes and options.
* @return array An array of HTML attributes and options.
*/
public function removeClasses(array|string $classes, array $options): array
{
$options += ['class' => []];
$options['class'] = $this->_toClassArray($options['class']);
$classes = $this->_toClassArray($classes);
foreach ($classes as $class) {
$indices = array_keys($options['class'], $class);
foreach ($indices as $index) {
if ($index !== false) {
unset($options['class'][$index]);
}
}
}
$options['class'] = trim(implode(' ', $options['class']));
return $options;
}
/**
* Checks if `$classes` are part of the `$options['class']`.
*
* @param array|string $classes Name of class(es) to check.
* @param array $options An array of HTML attributes and options.
* @return bool False if one or more class(es) do not exist.
*/
public function checkClasses(array|string $classes, array $options): bool
{
if (empty($options['class'])) {
return false;
}
$options['class'] = $this->_toClassArray($options['class']);
$classes = $this->_toClassArray($classes);
foreach ($classes as $class) {
if (!in_array($class, $options['class'])) {
return false;
}
}
return true;
}
/**
* Normalizes class strings/arrays.
*
* @param mixed $mixed One or more classes.
* @return array Classes as array.
*/
protected function _toClassArray(mixed $mixed): array
{
if ($mixed === null) {
return [];
}
if (!is_array($mixed)) {
$mixed = explode(' ', $mixed);
}
return $mixed;
}
/**
* Generates the classname of the given element
*
* @param string $element UI element to which the class can be applied (e.g. btn).
* @param string $class CSS class, which can be applied to the element.
* @return string|bool String of generated class, false if element/class not in list.
*/
public function genClassName(string $element, string $class): bool|string
{
if (!in_array($element, Element::values())) {
return false;
}
if (!in_array($class, Classes::values())) {
return false;
}
return $element . '-' . $class;
}
/**
* Generates a list of all classnames of a element
*
* @param string $element UI element
* @return array Array of all generated and raw styles
*/
public function genAllClassNames(string $element): array
{
$classes = [];
foreach (Classes::values() as $class) {
$classes[] = $this->genClassName($element, $class);
}
if ($element === Element::BTN) {
foreach (Classes::values() as $class) {
$classes[] = $this->genClassName(Element::BTN_OUTLINE, $class);
}
}
return array_merge(Classes::values(), $classes);
}
}