|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* TPluginModule class file. |
|
5
|
|
|
* |
|
6
|
|
|
* @author Brad Anderson <[email protected]> |
|
7
|
|
|
* @link https://github.com/pradosoft/prado |
|
8
|
|
|
* @license https://github.com/pradosoft/prado/blob/master/LICENSE |
|
9
|
|
|
* @package Prado |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
namespace Prado\Util; |
|
13
|
|
|
|
|
14
|
|
|
use Prado\Exceptions\TException; |
|
15
|
|
|
use Prado\TPropertyValue; |
|
16
|
|
|
use Prado\Util\Behaviors\TPageServiceExtraPathsBehavior; |
|
|
|
|
|
|
17
|
|
|
use ReflectionClass; |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* TPluginModule class. |
|
21
|
|
|
* |
|
22
|
|
|
* TPluginModule is for extending PRADO through Composer packages. This installs |
|
23
|
|
|
* its own Pages, where available, and its own error message file for the module. |
|
24
|
|
|
* |
|
25
|
|
|
* Plugin pages should implement their *.page with the following page code: |
|
26
|
|
|
* <code> |
|
27
|
|
|
* <com:TContent ID=<%$ PluginContentId %>> |
|
28
|
|
|
* ... your page content ... |
|
29
|
|
|
* </com:TContent> |
|
30
|
|
|
* </code> |
|
31
|
|
|
* The 'PluginContentId' application parameter is what all plugin pages should implement as |
|
32
|
|
|
* the page TContent ID. This way all plugin pages can be changed to the page MasterClass |
|
33
|
|
|
* layout TContentPlaceHolder for the application and layout. For example in the application |
|
34
|
|
|
* configuration file: |
|
35
|
|
|
* <code> |
|
36
|
|
|
* <parameters> |
|
37
|
|
|
* <parameter id="PluginContentId" value="Main" /> |
|
38
|
|
|
* </parameters> |
|
39
|
|
|
* </code> |
|
40
|
|
|
* @author Brad Anderson <[email protected]> |
|
41
|
|
|
* @package Prado |
|
42
|
|
|
* @since 4.2.0 |
|
43
|
|
|
*/ |
|
44
|
|
|
|
|
45
|
|
|
class TPluginModule extends \Prado\TModule implements IPluginModule |
|
46
|
|
|
{ |
|
47
|
|
|
/** Module pages directory for finding pages of a module */ |
|
48
|
|
|
public const PAGES_DIRECTORY = 'Pages'; |
|
49
|
|
|
|
|
50
|
|
|
/** @var string path of the plugin */ |
|
51
|
|
|
private $_pluginPath; |
|
52
|
|
|
|
|
53
|
|
|
/** @var string path of the pages folder for the plugin*/ |
|
54
|
|
|
private $_pagesPath; |
|
55
|
|
|
|
|
56
|
|
|
/** @var string relative pages path to $_pluginPath */ |
|
57
|
|
|
private $_relativePagesPath = self::PAGES_DIRECTORY; |
|
58
|
|
|
|
|
59
|
|
|
/** |
|
60
|
|
|
* initializes the plugin module, looks for a Pages directory and adds a new {@link TBehavior} |
|
61
|
|
|
* to help TPageService find any plugin module pages |
|
62
|
|
|
* @param array $config this is the manifest for the plugin module |
|
63
|
|
|
*/ |
|
64
|
|
|
public function init($config) |
|
65
|
|
|
{ |
|
66
|
|
|
if ($this->getPluginPagesPath() !== null) { |
|
|
|
|
|
|
67
|
|
|
$this->getApplication()->attachEventHandler('onBeginRequest', [$this, 'attachPageServiceBehavior']); |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
|
|
if ($errorFile = $this->getErrorFile()) { |
|
71
|
|
|
TException::addMessageFile($errorFile); |
|
72
|
|
|
} |
|
73
|
|
|
parent::init($config); |
|
|
|
|
|
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Called onBeginRequest |
|
78
|
|
|
* @param array $config this is the manifest for the plugin module |
|
79
|
|
|
* @param mixed $sender |
|
80
|
|
|
* @param mixed $param |
|
81
|
|
|
*/ |
|
82
|
|
|
public function attachPageServiceBehavior($sender, $param) |
|
|
|
|
|
|
83
|
|
|
{ |
|
84
|
|
|
$service = $this->getService(); |
|
85
|
|
|
if ($service->isa('Prado\\Web\\Services\\TPageService')) { |
|
|
|
|
|
|
86
|
|
|
$service->onAdditionalPagePaths[] = [$this, 'additionalPagePaths']; |
|
|
|
|
|
|
87
|
|
|
} |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* additionalPagePaths returns possible alternative paths for the $pagePath |
|
92
|
|
|
* @param Prado\Wob\Services\TPageService $service |
|
|
|
|
|
|
93
|
|
|
* @param string $pagePath |
|
94
|
|
|
*/ |
|
95
|
|
|
public function additionalPagePaths($service, $pagePath) |
|
96
|
|
|
{ |
|
97
|
|
|
return $this->getPluginPagesPath() . DIRECTORY_SEPARATOR . strtr($pagePath, '.', DIRECTORY_SEPARATOR); |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
|
|
101
|
|
|
/** |
|
102
|
|
|
* @return null|string the path of the error file for the plugin module |
|
103
|
|
|
*/ |
|
104
|
|
|
public function getErrorFile() |
|
105
|
|
|
{ |
|
106
|
|
|
$errorFile = $this->getPluginPath() . DIRECTORY_SEPARATOR . 'errorMessages.txt'; |
|
107
|
|
|
if (is_file($errorFile)) { |
|
108
|
|
|
return $errorFile; |
|
109
|
|
|
} |
|
110
|
|
|
return null; |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* @return string path of the plugin |
|
115
|
|
|
*/ |
|
116
|
|
|
public function getPluginPath() |
|
117
|
|
|
{ |
|
118
|
|
|
if ($this->_pluginPath === null) { |
|
119
|
|
|
$reflect = new ReflectionClass(get_class($this)); |
|
120
|
|
|
$this->_pluginPath = dirname($reflect->getFileName()); |
|
121
|
|
|
} |
|
122
|
|
|
return $this->_pluginPath; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
/** |
|
126
|
|
|
* @param mixed $path |
|
127
|
|
|
* @return string path of the plugin |
|
128
|
|
|
*/ |
|
129
|
|
|
public function setPluginPath($path) |
|
130
|
|
|
{ |
|
131
|
|
|
$this->_pluginPath = $path; |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
/** |
|
135
|
|
|
* @return string the path of the Pages director for the plugin, if available |
|
136
|
|
|
*/ |
|
137
|
|
|
public function getPluginPagesPath() |
|
138
|
|
|
{ |
|
139
|
|
|
if ($this->_pagesPath === null) { |
|
140
|
|
|
$path = $this->getPluginPath(); |
|
141
|
|
|
$basePath = $path . DIRECTORY_SEPARATOR . $this->_relativePagesPath; |
|
142
|
|
|
if (($this->_pagesPath = realpath($basePath)) === false || !is_dir($this->_pagesPath)) { |
|
143
|
|
|
$basePath = $path . DIRECTORY_SEPARATOR . strtolower($this->_relativePagesPath); |
|
144
|
|
|
if (($this->_pagesPath = realpath($basePath)) === false || !is_dir($this->_pagesPath)) { |
|
145
|
|
|
$this->_pagesPath = false; |
|
|
|
|
|
|
146
|
|
|
} |
|
147
|
|
|
} |
|
148
|
|
|
} |
|
149
|
|
|
return $this->_pagesPath; |
|
|
|
|
|
|
150
|
|
|
} |
|
151
|
|
|
|
|
152
|
|
|
/** |
|
153
|
|
|
* @param string $path |
|
154
|
|
|
*/ |
|
155
|
|
|
public function setPluginPagesPath($path) |
|
156
|
|
|
{ |
|
157
|
|
|
$this->_pagesPath = TPropertyValue::ensureString($path); |
|
158
|
|
|
$this->_relativePagesPath = null; |
|
159
|
|
|
} |
|
160
|
|
|
|
|
161
|
|
|
/** |
|
162
|
|
|
* @return string relative path from PluginPath |
|
163
|
|
|
*/ |
|
164
|
|
|
public function getRelativePagesPath() |
|
165
|
|
|
{ |
|
166
|
|
|
if ($this->_relativePagesPath === null) { |
|
167
|
|
|
if (stripos($this->_pagesPath, $this->getPluginPath()) === 0) { |
|
168
|
|
|
$this->_relativePagesPath = substr($this->_pagesPath, strlen($this->getPluginPath()) + 1); |
|
169
|
|
|
} |
|
170
|
|
|
} |
|
171
|
|
|
return $this->_relativePagesPath; |
|
172
|
|
|
} |
|
173
|
|
|
|
|
174
|
|
|
/** |
|
175
|
|
|
* @param string $relativePagesPath relative path of PluginPagesPath from PluginPath |
|
176
|
|
|
*/ |
|
177
|
|
|
public function setRelativePagesPath($relativePagesPath) |
|
178
|
|
|
{ |
|
179
|
|
|
$this->_relativePagesPath = TPropertyValue::ensureString($relativePagesPath); |
|
180
|
|
|
$this->_pagesPath = null; |
|
181
|
|
|
} |
|
182
|
|
|
} |
|
183
|
|
|
|
pradosoft /
prado
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths