-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathScripts.php
More file actions
124 lines (110 loc) · 3.42 KB
/
Scripts.php
File metadata and controls
124 lines (110 loc) · 3.42 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
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use function array_key_exists;
use function md5;
use function str_contains;
/**
* Collects information about which JavaScript
* files and objects are necessary to render
* the page and generates the relevant code.
*/
class Scripts
{
/**
* An array of SCRIPT tags
*
* @var array<string, array<string, int|string|array<string, string>>>
* @psalm-var array<string, array{has_onload: 0|1, filename: non-empty-string, params: array<string, string>}>
*/
private array $files = [];
/**
* A string of discrete javascript code snippets
*/
private string $code = '';
/**
* Generates new Scripts objects
*/
public function __construct(private readonly Template $template)
{
}
/**
* Adds a new file to the list of scripts
*
* @param string $filename The name of the file to include
* @param array<string, string> $params Additional parameters to pass to the file
*/
public function addFile(
string $filename,
array $params = [],
): void {
$hash = md5($filename);
if (array_key_exists($hash, $this->files) || $filename === '') {
return;
}
$hasOnload = $this->hasOnloadEvent($filename);
$this->files[$hash] = ['has_onload' => (int) $hasOnload, 'filename' => $filename, 'params' => $params];
}
/**
* Add new files to the list of scripts
*
* @param string[] $filelist The array of file names
*/
public function addFiles(array $filelist): void
{
foreach ($filelist as $filename) {
$this->addFile($filename);
}
}
/**
* Determines whether to fire up an onload event for a file
*
* @param string $filename The name of the file to be checked against the exclude list.
*
* @return bool true to fire up the event, false not to
*/
private function hasOnloadEvent(string $filename): bool
{
return ! str_contains($filename, 'vendor')
&& ! str_contains($filename, 'runtime.js')
&& ! str_contains($filename, 'index.php')
&& ! str_contains($filename, 'shared.js')
&& ! str_contains($filename, 'datetimepicker.js')
&& ! str_contains($filename, 'validator-messages.js');
}
/**
* Adds a new code snippet to the code to be executed
*
* @param string $code The JS code to be added
*/
public function addCode(string $code): void
{
$this->code .= $code . "\n";
}
/**
* Returns a list with filenames and a flag to indicate
* whether to register onload events for this file
*
* @return array<int, array<string, int|string>>
* @psalm-return list<array{name: non-empty-string, fire: 0|1}>
*/
public function getFiles(): array
{
$retval = [];
foreach ($this->files as $file) {
//If filename contains a "?", continue.
if (str_contains($file['filename'], '?')) {
continue;
}
$retval[] = ['name' => $file['filename'], 'fire' => $file['has_onload']];
}
return $retval;
}
/**
* Renders all the JavaScript file inclusions, code and events
*/
public function getDisplay(): string
{
return $this->template->render('scripts', ['files' => $this->files, 'code' => $this->code]);
}
}