|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Hyde\Foundation\Concerns; |
|
6
|
|
|
|
|
7
|
|
|
use BadMethodCallException; |
|
8
|
|
|
use Hyde\Foundation\HydeKernel; |
|
9
|
|
|
use Hyde\Pages\Concerns\HydePage; |
|
10
|
|
|
use Hyde\Pages\Contracts\DynamicPage; |
|
11
|
|
|
use function in_array; |
|
12
|
|
|
use InvalidArgumentException; |
|
13
|
|
|
use function is_subclass_of; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* @internal Single-use trait for the HydeKernel class. |
|
17
|
|
|
* |
|
18
|
|
|
* @see \Hyde\Foundation\HydeKernel |
|
19
|
|
|
*/ |
|
20
|
|
|
trait ManagesHydeKernel |
|
21
|
|
|
{ |
|
22
|
|
|
public static function getInstance(): HydeKernel |
|
23
|
|
|
{ |
|
24
|
|
|
return static::$instance; |
|
25
|
|
|
} |
|
26
|
|
|
|
|
27
|
|
|
public static function setInstance(HydeKernel $instance): void |
|
28
|
|
|
{ |
|
29
|
|
|
static::$instance = $instance; |
|
|
|
|
|
|
30
|
|
|
} |
|
31
|
|
|
|
|
32
|
|
|
public function getBasePath(): string |
|
33
|
|
|
{ |
|
34
|
|
|
return $this->basePath; |
|
35
|
|
|
} |
|
36
|
|
|
|
|
37
|
|
|
public function setBasePath(string $basePath): void |
|
38
|
|
|
{ |
|
39
|
|
|
$this->basePath = rtrim($basePath, '/\\'); |
|
|
|
|
|
|
40
|
|
|
} |
|
41
|
|
|
|
|
42
|
|
|
public function getSourceRoot(): string |
|
43
|
|
|
{ |
|
44
|
|
|
return $this->sourceRoot; |
|
45
|
|
|
} |
|
46
|
|
|
|
|
47
|
|
|
public function setSourceRoot(string $sourceRoot): void |
|
48
|
|
|
{ |
|
49
|
|
|
$this->sourceRoot = $this->normalizeSourcePath($sourceRoot); |
|
|
|
|
|
|
50
|
|
|
} |
|
51
|
|
|
|
|
52
|
|
|
public function getOutputDirectory(): string |
|
53
|
|
|
{ |
|
54
|
|
|
return $this->outputDirectory; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
|
|
public function setOutputDirectory(string $outputDirectory): void |
|
58
|
|
|
{ |
|
59
|
|
|
$this->outputDirectory = $this->normalizeSourcePath($outputDirectory); |
|
|
|
|
|
|
60
|
|
|
} |
|
61
|
|
|
|
|
62
|
|
|
public function getMediaDirectory(): string |
|
63
|
|
|
{ |
|
64
|
|
|
return $this->mediaDirectory; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
public function setMediaDirectory(string $mediaDirectory): void |
|
68
|
|
|
{ |
|
69
|
|
|
$this->mediaDirectory = $this->normalizeSourcePath($mediaDirectory); |
|
|
|
|
|
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
public function getMediaOutputDirectory(): string |
|
73
|
|
|
{ |
|
74
|
|
|
return ltrim($this->getMediaDirectory(), '_'); |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
|
|
/** |
|
78
|
|
|
* Developer Information. |
|
79
|
|
|
* |
|
80
|
|
|
* @experimental This feature is experimental and may change substantially before the 1.0.0 release. |
|
81
|
|
|
* |
|
82
|
|
|
* @deprecated This feature may be replaced by the {@see \Hyde\Foundation\Concerns\HydeExtension} system. |
|
83
|
|
|
* |
|
84
|
|
|
* If you are a package developer, and want a custom page class to be discovered, |
|
85
|
|
|
* you'll need to register it sometime before the boot process, before discovery is run. |
|
86
|
|
|
* Typically, you would do this by calling this method in the register method of a service provider. |
|
87
|
|
|
* Hyde will then automatically discover source files for the new page class, and compile them during the build process. |
|
88
|
|
|
* |
|
89
|
|
|
* @param class-string<\Hyde\Pages\Concerns\HydePage> $pageClass |
|
|
|
|
|
|
90
|
|
|
*/ |
|
91
|
|
|
public function registerPageClass(string $pageClass): void |
|
92
|
|
|
{ |
|
93
|
|
|
if ($this->booted) { |
|
94
|
|
|
// We throw an exception here to prevent the developer from registering a page class after the Kernel has been booted. |
|
95
|
|
|
// The reason we do this is because at this point all the source files have already been discovered and parsed. |
|
96
|
|
|
// If we allowed new classes after this point, we would have to reboot everything which adds complexity. |
|
97
|
|
|
|
|
98
|
|
|
throw new BadMethodCallException('Cannot register a page class after the Kernel has been booted.'); |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
if (! is_subclass_of($pageClass, HydePage::class)) { |
|
102
|
|
|
throw new InvalidArgumentException('The specified class must be a subclass of HydePage.'); |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
if (is_subclass_of($pageClass, DynamicPage::class)) { |
|
106
|
|
|
throw new InvalidArgumentException('The specified class must not be a subclass of DynamicPage.'); |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
if (! in_array($pageClass, $this->pageClasses, true)) { |
|
110
|
|
|
$this->pageClasses[] = $pageClass; |
|
|
|
|
|
|
111
|
|
|
} |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
|
|
/** @return array<class-string<\Hyde\Pages\Concerns\HydePage>> */ |
|
|
|
|
|
|
115
|
|
|
public function getRegisteredPageClasses(): array |
|
116
|
|
|
{ |
|
117
|
|
|
return $this->pageClasses; |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** @param class-string<\Hyde\Foundation\Concerns\HydeExtension> $extension */ |
|
|
|
|
|
|
121
|
|
|
public function registerExtension(string $extension): void |
|
122
|
|
|
{ |
|
123
|
|
|
if (! in_array($extension, $this->extensions, true)) { |
|
124
|
|
|
$this->extensions[] = $extension; |
|
|
|
|
|
|
125
|
|
|
} |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
/** @return array<class-string<\Hyde\Foundation\Concerns\HydeExtension>> */ |
|
|
|
|
|
|
129
|
|
|
public function getRegisteredExtensions(): array |
|
130
|
|
|
{ |
|
131
|
|
|
return $this->extensions; |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
protected function normalizeSourcePath(string $outputDirectory): string |
|
135
|
|
|
{ |
|
136
|
|
|
return $this->pathToRelative(rtrim($outputDirectory, '/\\')); |
|
|
|
|
|
|
137
|
|
|
} |
|
138
|
|
|
} |
|
139
|
|
|
|
hydephp /
develop
Loading history...
