blob: 5fd34b19e923ab1c482a9d7f894fb70db032c5b1 (
plain)
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
|
<?php
/**
* File containing the Modification class
*
* This file is part of the MediaWiki skin Chameleon.
*
* @copyright 2013 - 2014, 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\Components\Modifications;
use Skins\Chameleon\ChameleonTemplate;
use Skins\Chameleon\Components\Component;
/**
* Modification class
*
* This is the abstract base class of all modifications.
*
* Follows the Decorator pattern (Decorator role).
*
* @author Stephan Gambke
* @since 1.0
* @ingroup Skins
*/
abstract class Modification extends Component {
private $component = null;
/**
* @param Component $component
* @param \DOMElement $domElement
*/
public function __construct( Component $component, \DOMElement $domElement = null ) {
$this->component = $component;
parent::__construct( $component->getSkinTemplate(), $domElement, $component->getIndent() );
}
/**
* This method should apply any modifications to the decorated component
* available from the getComponent() method.
*/
abstract protected function applyModification();
/**
* @return \DOMElement|null
*/
public function getDomElementOfModification() {
return parent::getDomElement();
}
/**
* @return \DOMElement
*/
public function getDomElementOfComponent() {
return $this->getDomElement();
}
/**
* Sets the class string that should be assigned to the top-level html element of this component
*
* @param string | array | null $classes
*
*/
public function setClasses( $classes ) {
$this->getComponent()->setClasses( $classes );
}
/**
* @return Component
*/
public function getComponent() {
return $this->component;
}
/**
* @param Component $component
* @since 1.1
*/
protected function setComponent( Component $component ) {
$this->component = $component;
}
/**
* Adds the given class to the class string that should be assigned to the top-level html element of this component
*
* @param string | array | null $classes
*
* @return string | array
*/
public function addClasses( $classes ) {
$this->getComponent()->addClasses( $classes );
}
/**
* @return ChameleonTemplate
*/
public function getSkinTemplate() {
return $this->getComponent()->getSkinTemplate();
}
/**
* Returns the current indentation level
*
* @return int
*/
public function getIndent() {
return $this->getComponent()->getIndent();
}
/**
* Returns the class string that should be assigned to the top-level html element of this component
*
* @return string
*/
public function getClassString() {
return $this->getComponent()->getClassString();
}
/**
* Removes the given class from the class string that should be assigned to the top-level html element of this component
*
* @param string | array | null $classes
*
* @return string
*/
public function removeClasses( $classes ) {
$this->getComponent()->removeClasses( $classes );
}
/**
* Returns the DOMElement from the description XML file associated with this element.
*
* @return \DOMElement
*/
public function getDomElement() {
return $this->getComponent()->getDomElement();
}
/**
* Builds the HTML code for this component
*
* @return String the HTML code
*/
public function getHtml() {
$this->applyModification();
return $this->getComponent()->getHtml();
}
/**
* @return array the resource loader modules needed by this component
*/
public function getResourceLoaderModules() {
return $this->getComponent()->getResourceLoaderModules();
}
}
|
