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
|
<?php
/**
* File containing the ComponentFactory class
*
* This file is part of the MediaWiki skin Chameleon.
*
* @copyright 2013 - 2017, Stephan Gambke
* @license GNU General Public License, version 3 (or any later version)
*
* The Chameleon skin is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* The Chameleon skin is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
namespace Skins\Chameleon;
use DOMDocument;
use DOMElement;
use MWException;
use RuntimeException;
use Skins\Chameleon\Components\Component;
use Skins\Chameleon\Components\Container;
/**
* Class ComponentFactory
*
* @author Stephan Gambke
* @since 1.0
* @ingroup Skins
*/
class ComponentFactory {
// the root component of the page; should be of type Container
private $mRootComponent = null;
private $layoutFile;
private $skinTemplate;
const NAMESPACE_HIERARCHY = 'Skins\\Chameleon\\Components';
/**
* @param string $layoutFileName
*/
public function __construct( $layoutFileName ) {
$this->setLayoutFile( $layoutFileName );
}
/**
* @return Container
* @throws MWException
*/
public function getRootComponent() {
if ( $this->mRootComponent === null ) {
$doc = new DOMDocument();
$doc->load( $this->getLayoutFile() );
$doc->normalizeDocument();
$roots = $doc->getElementsByTagName( 'structure' );
if ( $roots->length > 0 ) {
$this->mRootComponent = $this->getComponent( $roots->item( 0 ) );
} else {
// TODO: catch other errors, e.g. malformed XML
throw new MWException( sprintf( '%s: XML description is missing an element: structure.', $this->getLayoutFile() ) );
}
}
return $this->mRootComponent;
}
/**
* @return string
*/
protected function getLayoutFile() {
return $this->layoutFile;
}
/**
* @param string $fileName
*/
public function setLayoutFile( $fileName ) {
$fileName = $this->sanitizeFileName( $fileName );
if ( !is_readable( $fileName ) ) {
throw new RuntimeException( "Expected an accessible {$fileName} layout file" );
}
$this->layoutFile = $fileName;
}
/**
* @param DOMElement $description
* @param int $indent
* @param string $htmlClassAttribute
*
* @throws MWException
* @return \Skins\Chameleon\Components\Container
*/
public function getComponent( DOMElement $description, $indent = 0, $htmlClassAttribute = '' ) {
$className = $this->getComponentClassName( $description );
$component = new $className( $this->getSkinTemplate(), $description, $indent, $htmlClassAttribute );
$children = $description->childNodes;
foreach ( $children as $child ) {
if ( $child instanceof DOMElement && strtolower( $child->nodeName ) === 'modification' ) {
$component = $this->getModifiedComponent( $child, $component );
}
}
return $component;
}
/**
* @param DOMElement $description
*
* @return string
* @throws MWException
* @since 1.1
*/
protected function getComponentClassName( DOMElement $description ) {
$className = $this->mapDescriptionToClassName( $description );
if ( !class_exists( $className ) || !is_subclass_of( $className, self::NAMESPACE_HIERARCHY . '\\Component' ) ) {
throw new MWException( sprintf( '%s (line %d): Invalid component type: %s.', $this->getLayoutFile(), $description->getLineNo(), $description->getAttribute( 'type' ) ) );
}
return $className;
}
/**
* @param DOMElement $description
*
* @return string
* @throws MWException
*/
protected function mapDescriptionToClassName( DOMElement $description ) {
$nodeName = strtolower( $description->nodeName );
$mapOfComponentsToClassNames = array(
'structure' => 'Structure',
'grid' => 'Grid',
'row' => 'Row',
'cell' => 'Cell',
'modification' => 'Silent',
);
if ( array_key_exists( $nodeName, $mapOfComponentsToClassNames ) ) {
return self::NAMESPACE_HIERARCHY . '\\' . $mapOfComponentsToClassNames[ $nodeName ];
}
if ( $nodeName === 'component' ) {
return $this->mapComponentDescriptionToClassName( $description );
}
throw new MWException( sprintf( '%s (line %d): XML element not allowed here: %s.', $this->getLayoutFile(), $description->getLineNo(), $description->nodeName ) );
}
/**
* @return mixed
*/
public function getSkinTemplate() {
return $this->skinTemplate;
}
/**
* @param ChameleonTemplate $skinTemplate
*/
public function setSkinTemplate( ChameleonTemplate $skinTemplate ) {
$this->skinTemplate = $skinTemplate;
}
/**
* @param DOMElement $description
* @param Component $component
*
* @return mixed
* @throws MWException
*/
protected function getModifiedComponent( DOMElement $description, Component $component ) {
if ( !$description->hasAttribute( 'type' ) ) {
throw new MWException( sprintf( '%s (line %d): Modification element missing an attribute: type.', $this->getLayoutFile(), $description->getLineNo() ) );
}
$className = 'Skins\\Chameleon\\Components\\Modifications\\' . $description->getAttribute( 'type' );
if ( !class_exists( $className ) || !is_subclass_of( $className, 'Skins\\Chameleon\\Components\\Modifications\\Modification' ) ) {
throw new MWException( sprintf( '%s (line %d): Invalid modification type: %s.', $this->getLayoutFile(), $description->getLineNo(), $description->getAttribute( 'type' ) ) );
}
return new $className( $component, $description );
}
/**
* @param string $fileName
*
* @return string
*/
public function sanitizeFileName( $fileName ) {
return str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $fileName );
}
/**
* @param DOMElement $description
* @return string
*/
protected function mapComponentDescriptionToClassName( DOMElement $description ) {
if ( $description->hasAttribute( 'type' ) ) {
$className = $description->getAttribute( 'type' );
$parent = $description->parentNode;
if ( $parent instanceof DOMElement && $parent->hasAttribute( 'type' ) ) {
$fullClassName = join(
'\\',
array(
self::NAMESPACE_HIERARCHY,
$parent->getAttribute( 'type' ),
$className
)
);
if ( class_exists( $fullClassName ) ) {
return $fullClassName;
}
}
$chameleonClassName = join( '\\', array( self::NAMESPACE_HIERARCHY, $className ) );
if ( !class_exists( $chameleonClassName ) ) {
return $className;
}
return $chameleonClassName;
}
return self::NAMESPACE_HIERARCHY . 'Container';
}
}
|
