summaryrefslogtreecommitdiff
path: root/www/wiki/skins/chameleon/tests/phpunit/Util/DocumentElementFinder.php
blob: 6f0d0ac5751b1a135fa755fd3e896a719dcea389 (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
<?php
/**
 * This file is part of the MediaWiki skin Chameleon.
 *
 * @copyright 2013 - 2014, Stephan Gambke, mwjames
 * @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\Tests\Util;

use DOMDocument;
use DOMElement;

use RuntimeException;

/**
 * @group skins-chameleon
 * @group mediawiki-databaseless
 *
 * @author mwjames
 * @author Stephan Gambke
 * @since 1.0
 * @ingroup Skins
 * @ingroup Test
 */
class DocumentElementFinder {

	protected $file = null;
	protected $document = null;

	/**
	 * @since 1.0
	 *
	 * @param string $file
	 */
	public function __construct( $file ) {
		$this->file = $file;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $type
	 *
	 * @return DOMElement|null
	 */
	public function getComponentByTypeAttribute( $type ) {

		$elements = $this->getComponentsByTypeAttribute( $type );

		if ( count( $elements ) > 0 ) {
			return array_shift( $elements );
		}

		return null;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $type
	 *
	 * @return DOMElement[]
	 */
	public function getComponentsByTypeAttribute( $type ) {

		$elements = array();

		$elementList = $this->getDocument()->getElementsByTagName( strtolower( $type ) );
		foreach( $elementList as $element ){
			$elements[] = $element;
		}

		$elementList = $this->getDocument()->getElementsByTagName( '*' );
		foreach ( $elementList as $element ) {
			if ( $element instanceOf DOMElement && $element->hasAttribute( 'type' ) && $element->getAttribute( 'type' ) === $type ) {
				$elements[] = $element;
			}
		}

		return $elements;
	}

	protected function getDocument() {

		if ( $this->document !== null ) {
			return $this->document;
		}

		$file = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $this->file );

		if ( !is_readable( $file ) ) {
			throw new RuntimeException( "Expected an accessible {$file} path" );
		}

		$document = new DOMDocument;
		$document->validateOnParse = true;

		if ( !$document->load( $file ) ) {
			throw new RuntimeException( "Unable to load {$file} file" );
		}

		$document->normalizeDocument();

		return $document;
	}

}