summaryrefslogtreecommitdiff
path: root/www/wiki/skins/chameleon/src/Components/Component.php
blob: e6dc51c113537d73d5482734ea3430d23aa0b20a (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
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
<?php
/**
 * File containing the Component 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;

use SkinChameleon;
use Skins\Chameleon\ChameleonTemplate;

/**
 * Component class
 *
 * This is the base class of all components.
 *
 * @author Stephan Gambke
 * @since 1.0
 * @ingroup Skins
 */
abstract class Component {

	private $mSkinTemplate;
	private $mIndent = 0;
	private $mClasses = array();
	private $mDomElement = null;

	/**
	 * @param ChameleonTemplate $template
	 * @param \DOMElement|null  $domElement
	 * @param int               $indent
	 */
	public function __construct( ChameleonTemplate $template, \DOMElement $domElement = null, $indent = 0 ) {

		$this->mSkinTemplate = $template;
		$this->mIndent       = (int) $indent;
		$this->mDomElement   = $domElement;

		if ( $domElement !== null ) {
			$this->addClasses( $domElement->getAttribute( 'class' ) );
		}
	}

	/**
	 * 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->mClasses = array();
		$this->addClasses( $classes );

	}

	/**
	 * 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 ) {

		$classesArray = $this->transformClassesToArray( $classes );

		if ( !empty( $classesArray ) ) {
			$classesArray   = array_combine( $classesArray, $classesArray );
			$this->mClasses = array_merge( $this->mClasses, $classesArray );
		}
	}

	/**
	 * @param string | array | null $classes
	 *
	 * @return array
	 * @throws \MWException
	 */
	protected function transformClassesToArray ( $classes ) {

		if ( empty( $classes ) ) {
			return array();
		} elseif ( is_array( $classes )) {
			return $classes;
		} elseif ( is_string( $classes ) ) {
			return explode( ' ', $classes );
		} else {
			throw new \MWException( __METHOD__ . ': Expected String or Array; ' . getType( $classes ) . ' given.' );
		}

	}

	/**
	 * @return ChameleonTemplate
	 */
	public function getSkinTemplate() {

		return $this->mSkinTemplate;
	}

	/**
	 * @since 1.1
	 * @return SkinChameleon
	 */
	public function getSkin() {

		return $this->mSkinTemplate->getSkin();
	}

	/**
	 * Returns the current indentation level
	 *
	 * @return int
	 */
	public function getIndent() {

		return $this->mIndent;
	}

	/**
	 * Returns the class string that should be assigned to the top-level html element of this component
	 *
	 * @return string
	 */
	public function getClassString() {

		return implode( ' ', $this->mClasses );
	}

	/**
	 * 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 ) {

		$classesArray = $this->transformClassesToArray( $classes );

		$this->mClasses = array_diff( $this->mClasses, $classesArray );
	}

	/**
	 * Returns the DOMElement from the description XML file associated with this element.
	 *
	 * @return \DOMElement
	 */
	public function getDomElement() {
		return $this->mDomElement;
	}

	/**
	 * Builds the HTML code for this component
	 *
	 * @return String the HTML code
	 */
	abstract public function getHtml();

	/**
	 * @return string[] the resource loader modules needed by this component
	 */
	public function getResourceLoaderModules() {
		return array();
	}

	/**
	 * Adds $indent to (or subtracts from if negative) the current indentation level.
	 * Inserts a new line and a number of tabs according to the new indentation level.
	 *
	 * @param int $indent
	 * @return string
	 * @throws \MWException
	 */
	protected function indent( $indent = 0 ) {

		$this->mIndent += (int) $indent;

		if ( $this->mIndent < 0 ) {
			throw new \MWException('Attempted HTML indentation of ' .$this->mIndent );
		}

		return "\n" . str_repeat( "\t", $this->mIndent );
	}

	/**
	 * @param string $attributeName
	 * @param null | string $default
	 * @return null | string
	 */
	protected function getAttribute( $attributeName, $default = null ) {

		$element = $this->getDomElement();

		if ( $element !== null && $element->hasAttribute( $attributeName ) ) {
			return $element->getAttribute( $attributeName );
		}

		return $default;
	}
}