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
|
<?php
#%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%#
# Pagelet representation class [Thomas Lange <code@nerdmind.de>] #
#%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%#
# #
# [More information coming soon] #
# #
#%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%#
namespace BigPipe;
class Pagelet extends Item {
private $HTML = '';
private $JSCode = [];
private $priority = NULL;
private $resources = [];
private $dependencies = [];
private $tagName = 'div';
private $tagHTML = '';
#===============================================================================
# Priorities for pagelet sorting
#===============================================================================
const PRIORITY_HIGHEST = 100;
const PRIORITY_HIGH = 75;
const PRIORITY_NORMAL = 50;
const PRIORITY_LOW = 25;
const PRIORITY_LOWEST = 0;
#===============================================================================
# Phase numbers for PhaseDoneJS
#===============================================================================
const PHASE_INIT = 0; # After the pagelet object was initialized
const PHASE_LOADCSS = 1; # After all the CSS resources have been loaded
const PHASE_HTML = 2; # After the placeholder HTML was replaced
const PHASE_LOADJS = 3; # After all the JS resources have been loaded
const PHASE_DONE = 4; # After the static JS code has been executed
public function __construct($customID = NULL, $priority = self::PRIORITY_NORMAL) {
$this->ID = $customID ?? spl_object_hash($this);
$this->priority = $priority;
$this->resources = array_pad($this->resources, 2, []);
$this->phaseDoneJS = array_pad($this->phaseDoneJS, 5, []);
BigPipe::enqueue($this);
}
#===============================================================================
# Return the priority
#===============================================================================
public function getPriority() {
return $this->priority;
}
#===============================================================================
# Return the HTML content
#===============================================================================
public function getHTML() {
return $this->HTML;
}
#===============================================================================
# Return the main JS code
#===============================================================================
public function getJSCode(): array {
return $this->JSCode;
}
#===============================================================================
# Return attached resources
#===============================================================================
public function getResources(): array {
return $this->resources;
}
#===============================================================================
# Return all display dependencies
#===============================================================================
public function getDependencies(): array {
return array_unique($this->dependencies);
}
#===============================================================================
# Add HTML or attach more
#===============================================================================
public function addHTML($HTML) {
return $this->HTML .= $HTML;
}
#===============================================================================
# Add resource
#===============================================================================
public function addResource(Resource $Resource): Resource {
return $this->resources[$Resource->getType()][] = $Resource;
}
#===============================================================================
# Attach a main JS code part
#===============================================================================
public function addJSCode($code) {
return $this->JSCode[] = $code;
}
#===============================================================================
# Attach a display dependency
#===============================================================================
public function addDependency(Pagelet $Pagelet) {
return $this->dependencies[] = $Pagelet->getID();
}
#===============================================================================
# Set custom placeholder tag name
#===============================================================================
public function setTagName($tagName) {
return $this->tagName = $tagName;
}
#===============================================================================
# Set custom placeholder HTML
#===============================================================================
public function setPlaceholderHTML($HTML) {
return $this->tagHTML = $HTML;
}
#===============================================================================
# Return the pagelet structure
#===============================================================================
public function getStructure(): array {
foreach($this->getResources()[Resource::TYPE_STYLESHEET] as $Resource) {
$stylesheets[] = $Resource->getStructure();
}
foreach($this->getResources()[Resource::TYPE_JAVASCRIPT] as $Resource) {
$javascripts[] = $Resource->getStructure();
}
return [
'ID' => $this->getID(),
'NEED' => $this->getDependencies(),
'RSRC' => [
Resource::TYPE_STYLESHEET => $stylesheets ?? [],
Resource::TYPE_JAVASCRIPT => $javascripts ?? []
],
'CODE' => $this->getJSCode(),
'PHASE' => $this->getPhaseDoneJS()
];
}
#===============================================================================
# Flush pagelet immediately
#===============================================================================
public function flush() {
if(BigPipe::enabled()) {
$pageletHTML = str_replace(["\r", "\n", "\t"], '', $this->getHTML());
$pageletHTML = str_replace('--', '--', $pageletHTML);
$pageletJSON = json_encode($this->getStructure());
echo "<code hidden id=\"_{$this->getID()}\"><!-- {$pageletHTML} --></code>\n";
echo "<script>BigPipe.onPageletArrive({$pageletJSON}, document.getElementById(\"_{$this->getID()}\"));</script>\n\n";
BigPipe::dequeue($this);
BigPipe::flushOutputBuffer();
}
}
#===============================================================================
# Magic method: __toString()
#===============================================================================
public function __toString() {
$pageletHTML = "<{$this->tagName} id=\"{$this->getID()}\">";
$pageletHTML .= !BigPipe::enabled() ? $this->getHTML() : $this->tagHTML;
$pageletHTML .= "</{$this->tagName}>";
return $pageletHTML;
}
}
|
