-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathView.php
578 lines (529 loc) · 16.4 KB
/
View.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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<?php
/**
* Copyright 2021 Jeremy Presutti <[email protected]>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
declare(strict_types=1);
namespace Feast;
use Exception;
use Feast\Collection\Collection;
use Feast\Enums\DocType;
use Feast\Interfaces\ConfigInterface;
use Feast\Interfaces\RouterInterface;
use Feast\ServiceContainer\ServiceContainerItemInterface;
use Feast\Traits\DependencyInjected;
use stdClass;
/**
* Manages the rendering of views or json views as requested.
*/
// Extends stdClass for type hint assistance
class View extends stdClass implements ServiceContainerItemInterface
{
use DependencyInjected;
private string $baseUrl;
/** @var array<string> */
private array $css = [];
private bool $outputDisabled = false;
private string $content = '';
private DocType $docType = DocType::HTML_5;
private string $dtd = '<!DOCTYPE html>' . "\n" . '<html>';
private string $encoding = 'UTF-8';
private array $postScripts = [];
private array $preScripts = [];
private array $postScriptSnippet = [];
private array $preScriptSnippet = [];
private bool $showLayout = true;
private string $layoutFile = 'layout';
private string $title = '';
/**
* @param ConfigInterface $config
* @param RouterInterface $router
* @throws ServiceContainer\NotFoundException|ServiceContainer\ContainerException
* @throws Exception
*/
public function __construct(protected ConfigInterface $config, protected RouterInterface $router)
{
$this->checkInjected();
$this->baseUrl = (string)$config->getSetting('siteurl');
$docType = DocType::tryFrom((string)$config->getSetting('html.doctype', DocType::HTML_5->value)) ?? DocType::HTML_5;
$this->setDoctype($docType);
}
/**
* Outputs the view to the browser.
*
* If layout is not disabled, includes the layout file first.
*
* @param string $controller
* @param string $action
* @param string $route = ''
*/
public function showView(string $controller, string $action, string $route = ''): void
{
if ($this->outputDisabled) {
return;
}
$content = APPLICATION_ROOT . $route . 'Views/' . $controller . '/' . $action . '.phtml';
if ($this->showLayout) {
/** @psalm-suppress UnresolvableInclude */
include(APPLICATION_ROOT . $route . 'Views/' . $this->layoutFile . '.phtml');
} else {
/** @psalm-suppress UnresolvableInclude */
include($content);
}
}
/**
* Disable view output.
*/
public function disableOutput(): void
{
$this->outputDisabled = true;
}
/**
* Enable view output.
*/
public function enableOutput(): void
{
$this->outputDisabled = false;
}
/**
* Check if output is disabled.
*
* @return bool
*/
public function outputDisabled(): bool
{
return $this->outputDisabled;
}
/**
* Check if output is enabled.
*
* @return bool
*/
public function outputEnabled(): bool
{
return !$this->outputDisabled();
}
/**
* Disable the view layout.
*/
public function disableLayout(): void
{
$this->showLayout = false;
}
/**
* Enable the view layout.
*/
public function enableLayout(): void
{
$this->showLayout = true;
}
/**
* Check if layout view is enabled.
*
* @return bool
*/
public function layoutEnabled(): bool
{
return $this->showLayout;
}
/**
* Check if layout view is disabled.
*
* @return bool
*/
public function layoutDisabled(): bool
{
return !$this->layoutEnabled();
}
/**
* Returns all the preScripts as script tags.
*
* @return string
*/
public function getPreScripts(): string
{
$allScripts = '';
/** @var string $script */
foreach ($this->preScripts as $script) {
$filename = str_starts_with($script, 'http') ? $script : '/js/' . $script;
$allScripts .= '<script type="text/javascript" src="' . $filename . '"></script>' . PHP_EOL;
}
/** @var string $script */
foreach ($this->preScriptSnippet as $script) {
$allScripts .= '<script type="text/javascript">' . $script . '</script>' . PHP_EOL;
}
return $allScripts;
}
/**
* Adds a javascript file for the <head> tag.
*
* Feast uses the /js/ folder for the base directory of all scripts.
* If onlyOne is true, ensures the script is only loaded once.
*
* @param string $fileName
* @param bool $onlyOne
*/
public function addPreScript(string $fileName, bool $onlyOne = true): void
{
if (!$onlyOne || !in_array($fileName, $this->preScripts)) {
$this->preScripts[] = $fileName;
}
}
/**
* Adds multiple javascript file for the <head> tag.
*
* Feast uses the /js/ folder for the base directory of all scripts.
* If onlyOne is true, ensures the scripts are each only loaded once.
*
* @param array<string> $fileNames
* @param bool $onlyOne
*/
public function addPreScripts(array $fileNames, bool $onlyOne = true): void
{
foreach ($fileNames as $fileName) {
$this->addPreScript($fileName, $onlyOne);
}
}
/**
* Adds a JavaScript snippet for the <head> tag.
*
* @param string $snippet
*/
public function addPreScriptSnippet(string $snippet): void
{
$this->preScriptSnippet[] = $snippet;
}
/**
* Returns all the end-of-body scripts as script tags
*
* @return string
*/
public function getPostScripts(): string
{
$allScripts = '';
/** @var string $script */
foreach ($this->postScripts as $script) {
$filename = str_starts_with($script, 'http') ? $script : '/js/' . $script;
$allScripts .= '<script type="text/javascript" src="' . $filename . '"></script>' . PHP_EOL;
}
/** @var string $script */
foreach ($this->postScriptSnippet as $script) {
$allScripts .= '<script type="text/javascript">' . $script . '</script>' . PHP_EOL;
}
return $allScripts;
}
/**
* Adds a javascript file for the end of the <body> tag.
*
* Feast uses the /js/ folder for the base directory of all scripts.
* If onlyOne is true, ensures the script is only loaded once.
*
* @param string $fileName
* @param bool $onlyOne
*/
public function addPostScript(string $fileName, bool $onlyOne = true): void
{
if (!$onlyOne || !in_array($fileName, $this->postScripts)) {
$this->postScripts[] = $fileName;
}
}
/**
* Adds multiple javascript files for the end of <body> tag.
*
* Feast uses the /js/ folder for the base directory of all scripts.
* If onlyOne is true, ensures the scripts are each only loaded once.
*
* @param array<string> $fileNames
* @param bool $onlyOne
*/
public function addPostScripts(array $fileNames, bool $onlyOne = true): void
{
foreach ($fileNames as $fileName) {
$this->addPostScript($fileName, $onlyOne);
}
}
/**
* Adds a JavaScript snippet for the end of <body> tag.
*
* @param string $snippet
*/
public function addPostScriptSnippet(string $snippet): void
{
$this->postScriptSnippet[] = $snippet;
}
/**
* Gets all the css style sheets that have been loaded as html link tags.
*
* @return string
*/
public function getCss(): string
{
$allCss = '';
foreach ($this->css as $css) {
$allCss .= '<link rel="stylesheet" type="text/css" href="/css/' . $css . '" />' . PHP_EOL;
}
return $allCss;
}
/**
* Adds a css file to the page,
*
* Feast uses the /css/ folder for the base directory for all stylesheets.
*
* @param string $fileName
*/
public function addCssFile(string $fileName): void
{
if (!in_array($fileName, $this->css)) {
$this->css[] = $fileName;
}
}
/**
* Adds multiple css file to the page,
*
* Feast uses the /css/ folder for the base directory for all stylesheets.
*
* @param array<string> $fileNames
*/
public function addCssFiles(array $fileNames): void
{
foreach ($fileNames as $fileName) {
$this->addCssFile($fileName);
}
}
/**
* Add or change the page title.
*
* @param string $title
*/
public function setTitle(string $title): void
{
$this->title = $title;
}
/**
* Returns the page title.
*
* @param bool $html
* @return string
*/
public function getTitle(bool $html = true): string
{
if ($html) {
return '<title>' . $this->title . '</title>' . PHP_EOL;
}
return $this->title;
}
/**
* Sets the doc type of the page.
*
* Also sets the doctype declaration
*
* @param DocType $doctype
* @throws Exception
*/
public function setDoctype(DocType $doctype = DocType::HTML_5): void
{
if ($doctype == DocType::HTML_4_01_TRANSITIONAL) {
$this->dtd = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
} elseif ($doctype == DocType::HTML_4_01_STRICT) {
$this->dtd = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">';
} elseif ($doctype == DocType::HTML_4_01_FRAMESET) {
$this->dtd = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">';
} elseif ($doctype == DocType::HTML_5) {
$this->dtd = '<!DOCTYPE html>' . "\n" . '<html>';
} elseif ($doctype == DocType::XHTML_1_0_TRANSITIONAL) {
$this->dtd = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
} elseif ($doctype == DocType::XHTML_1_0_STRICT) {
$this->dtd = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">';
} elseif ($doctype == DocType::XHTML_1_0_FRAMESET) {
$this->dtd = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">';
} else { // DocType::XHTML_1_1
$this->dtd = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">';
}
$this->docType = $doctype;
}
/**
* Get the Doctype Declaration.
*
* @return string
*/
public function getDtd(): string
{
return $this->dtd . PHP_EOL;
}
/**
* Get the Doctype.
*
* @return DocType
*/
public function getDocType(): DocType
{
return $this->docType;
}
/**
* Set the encoding for the page.
*
* Default is UTF-8.
*
* @param string $encoding
*/
public function setEncoding(string $encoding = 'UTF-8'): void
{
$this->encoding = $encoding;
}
/**
* Returns the meta tag page encoding.
*
* @return string
* @throws Exception
*/
public function getEncodingHtml(): string
{
return match ($this->docType) {
DocType::XHTML_1_0_STRICT, DocType::XHTML_1_0_TRANSITIONAL, DocType::XHTML_1_0_FRAMESET, DocType::XHTML_1_1 => '<meta http-equiv="Content-type" content="text/html;charset=' . $this->encoding . '" />' . PHP_EOL,
DocType::HTML_4_01_TRANSITIONAL, DocType::HTML_4_01_FRAMESET, DocType::HTML_4_01_STRICT => '<meta http-equiv="Content-type" content="text/html;charset=' . $this->encoding . '">' . PHP_EOL,
DocType::HTML_5 => '<meta charset="' . $this->encoding . '">' . PHP_EOL
};
}
/**
* Get the raw encoding.
*
* @return string
*/
public function getEncoding(): string
{
return $this->encoding;
}
/**
* Render a partial view.
*
* Any duplicate arguments will override ones in the view during the partial.
* The view itself does not change.
*
* @param string $file - filename to use for the view (in Views folder).
* @param array $arguments - variables to be assigned onto the view.
* @param bool $includeView - whether to load the view variables for the partial or not.
*/
public function partial(string $file, array $arguments = [], bool $includeView = true): void
{
new Partial($file, $this, $arguments, includeView: $includeView);
}
/**
* Render partial views by looping through the arguments loop.
*
* Any duplicate arguments will override ones in the view during the partial.
* The view itself does not change.
*
* @param string $file - filename to use for the view (in Views folder).
* @param array<array> $arguments - an array of arrays of variables or a collection of arrays to be assigned onto the view.
*/
public function partialLoop(string $file, array|Collection $arguments): void
{
foreach ($arguments as $key => $argument) {
new Partial($file, $this, $argument, $key);
}
}
/**
* Get the url path.
*
* Designed for use in views to avoid having to call route class in view.
*
* @param string|null $action
* @param string|null $controller
* @param array<string> $arguments
* @param array<string> $queryString
* @param string|null $module
* @param string $route
* @param bool $fullPath
* @param string|null $requestMethod
* @return string
* @throws Exception
*/
public function url(
?string $action = null,
?string $controller = null,
array $arguments = [],
array $queryString = [],
?string $module = null,
string $route = 'Default',
bool $fullPath = false,
?string $requestMethod = null
): string {
$path = (string)$this->config->getSetting('siteurl');
return ($fullPath ? $path : '') . '/' . $this->router->getPath(
$action,
$controller,
$arguments,
$queryString,
$module,
$route,
$requestMethod
);
}
/**
* Reset the view to be void of css or js, enable output, and enable layout.
*/
public function emptyView(): void
{
$this->preScripts = [];
$this->postScripts = [];
$this->css = [];
$this->preScriptSnippet = [];
$this->postScriptSnippet = [];
$this->outputDisabled = false;
$this->showLayout = true;
$this->setLayoutFile();
$this->setEncoding();
$this->setTitle('');
}
/**
* Get layout filename.
*
* @return string
*/
public function getLayoutFile(): string
{
return $this->layoutFile;
}
/**
* Set layout filename.
*
* @param string $file
*/
public function setLayoutFile(string $file = 'layout'): void
{
$this->layoutFile = str_replace('.phtml', '', $file);
}
/**
* Set a dynamic value on the view.
*
* @param string $key
* @param string|int|bool|float|object|array|null $value
*/
public function __set(string $key, string|int|bool|float|object|null|array $value): void
{
$this->$key = $value;
}
/**
* Get a dynamic value from the view.
*
* @param string $value
* @return mixed
*/
public function __get(string $value): mixed
{
return $this->$value ?? null;
}
}