-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMenu.php
More file actions
311 lines (271 loc) · 6.32 KB
/
Copy pathMenu.php
File metadata and controls
311 lines (271 loc) · 6.32 KB
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
<?php
/**
* @author : Jakiboy
* @package : FloatPHP
* @subpackage : Helpers Html Component
* @version : 1.5.x
* @copyright : (c) 2018 - 2025 Jihad Sinnaour <[email protected]>
* @link : https://floatphp.com
* @license : MIT
*
* This file is a part of FloatPHP Framework.
*/
declare(strict_types=1);
namespace FloatPHP\Helpers\Html;
use FloatPHP\Helpers\Filesystem\Cache;
/**
* Menu factory class.
*/
final class Menu
{
use \FloatPHP\Kernel\TraitConfiguration,
\FloatPHP\Helpers\Framework\tr\TraitPermissionable,
\FloatPHP\Helpers\Framework\tr\TraitTranslatable,
\FloatPHP\Helpers\Framework\tr\TraitRequestable;
/**
* @access private
* @var array $menu
* @var array $native
* @var bool $debug
* @var string $lang
* @var int $user
* @var string $itemClass
* @var string $linkClass
* @var string $linkSubClass
* @var string $subClass
* @var string $activeClass
* @var string $SHOW
*/
private $menu;
private $native;
private $debug;
private $lang;
private $user;
private $itemClass;
private $linkClass;
private $linkSubClass;
private $subClass;
private $activeClass;
private $showClass;
/**
* @access private
* @var string LANG
* @var string ITEM
* @var string LINK
* @var string LINKSUB
* @var string SUB
* @var string ACTIVE
*/
private const ITEM = 'nav-item';
private const LINK = 'nav-link';
private const LINKSUB = 'with-sub';
private const SUB = 'nav-sub';
private const ACTIVE = 'active';
private const SHOW = 'show';
/**
* @param int $user
* @param string $lang
*/
function __construct(?int $user = null, ?string $lang = null)
{
$this->debug = $this->isDebug();
$this->user = $user;
$this->lang = $lang;
$this->native = $this->menu = $this->getMenu();
$this->setCSS();
$this->getTranslatorObject($this->lang);
}
/**
* Get native menu without translation.
*
* @access public
* @return array
*/
public function getNative() : array
{
return $this->native;
}
/**
* Generate translated menu.
*
* @access public
* @return array
*/
public function generate() : array
{
$this->setActive();
return $this->menu;
}
/**
* Prepare menu generating.
*
* @access public
* @return object
*/
public function prepare() : Menu
{
if ( !$this->debug ) {
$cache = new Cache();
$key = $cache->getKey('menu', [
'user' => $this->user,
'lang' => $this->lang
]);
$data = $cache->get($key, $status);
if ( !$status ) {
$data = $this->build($this->menu);
$cache->set($key, $data, 0, 'menu');
}
$this->menu = $data;
} else {
$this->menu = $this->build($this->menu);
}
return $this;
}
/**
* Append item to menu array.
*
* @access public
* @param array $item
* @return object
*/
public function with(array $item) : Menu
{
$item = $this->build($item);
$this->menu = $this->mergeArray($this->menu, $item);
return $this;
}
/**
* Set menu CSS class.
*
* @access public
* @param array $css
* @return void
*/
public function setCSS($css = []) : void
{
$this->itemClass = $css['item'] ?? self::ITEM;
$this->linkClass = $css['link'] ?? self::LINK;
$this->linkSubClass = $css['linksub'] ?? self::LINKSUB;
$this->subClass = $css['sub'] ?? self::SUB;
$this->showClass = $css['show'] ?? self::SHOW;
$this->activeClass = $css['active'] ?? self::ACTIVE;
}
/**
* Build menu.
*
* @access private
* @param array $menu
* @return array
*/
private function build(array $menu) : array
{
// Convert 2D
$temp = $menu[0] ?? false;
if ( !$this->isType('array', $temp) ) {
$menu = [$menu];
}
foreach ($menu as $key => $item) {
// Check 2D
if ( !$this->isType('int', $key) && !$this->isType('array', $item) ) {
continue;
}
// Translate
if ( isset($menu[$key]['name']) ) {
$menu[$key]['name'] = $this->translator->translate($item['name']);
}
// Set access
if ( !$this->hasAccess($item) ) {
unset($menu[$key]);
}
}
return $this->filterArray($menu);
}
/**
* Check whether user has menu access.
*
* @access private
* @param array $item
* @return bool
*/
private function hasAccess(array $item) : bool
{
if ( isset($item['role']) ) {
return $this->hasRole($item['role']);
}
return true;
}
/**
* Set active menu.
*
* @access private
* @return void
*/
private function setActive() : void
{
foreach ($this->menu as $key => $item) {
if ( isset($item['type']) && $item['type'] == 'menu' ) {
$sub = $item['sub'] ?? false;
// Default link class
$linkClass = $this->menu[$key]['link-class'] ?? '';
if ( empty($linkClass) ) {
$linkClass = $this->linkClass;
}
$this->menu[$key]['link-class'] = $linkClass;
if ( $sub !== false ) {
// Activate first level menu sub class
$this->menu[$key]['link-class'] .= " {$this->linkSubClass}";
foreach ($sub as $n => $i) {
// Default sub parent class
$itemClass = $this->menu[$key]['class'] ?? '';
if ( empty($itemClass) ) {
$itemClass = $this->itemClass;
}
// Default sub class
$subClass = $this->menu[$key]['sub'][$n]['class'] ?? '';
if ( empty($subClass) ) {
$subClass = $this->subClass;
}
// Activate sub and parent
if ( $this->isActive($i['url']) ) {
$itemClass .= " {$this->activeClass} {$this->showClass}";
$subClass .= " {$this->activeClass}";
}
$this->menu[$key]['class'] = $itemClass;
$this->menu[$key]['sub'][$n]['class'] = $subClass;
// Translate sub
$this->menu[$key]['sub'][$n]['name'] = $this->translator->translate($i['name']);
// Set sub access
if ( !$this->hasAccess($i) ) {
unset($this->menu[$key]['sub'][$n]);
}
}
} else {
// Default first level class
$itemClass = $this->menu[$key]['class'] ?? '';
if ( empty($itemClass) ) {
$itemClass = $this->itemClass;
}
// Activate first level menu
if ( $this->isActive($item['url']) ) {
$itemClass .= " {$this->activeClass}";
}
$this->menu[$key]['class'] = $itemClass;
}
}
}
}
/**
* Check whether menu is active.
*
* @access private
* @param string $url
* @return bool
*/
private function isActive($url = '') : bool
{
if ( $this->hasString($this->getServer('request-uri'), $url) ) {
return true;
}
return false;
}
}