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
|
<?php
/**
* File holding the IdRegistry class
*
* This file is part of the MediaWiki skin Chameleon.
*
* @copyright 2013 - 2015, 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;
/**
* Class IdRegistry provides a registry and access methods to ensure each id is only used once per HTML page.
*
* @author Stephan Gambke
* @since 1.0
* @ingroup Skins
*/
class IdRegistry {
private static $sInstance;
private $mRegistry = array();
/**
* @return IdRegistry
*/
public static function getRegistry() {
if ( self::$sInstance === null ) {
self::$sInstance = new IdRegistry();
}
return self::$sInstance;
}
/**
* Returns the opening tag of an HTML element in a string.
*
* The advantage over Html::openElement is that any id attribute is ensured to be unique.
*
* @param string $tag
* @param array $attributes
*
* @return string
*/
public function openElement( $tag, $attributes = array() ) {
if ( is_array( $attributes ) && isset( $attributes[ 'id' ] ) ) {
$attributes[ 'id' ] = $this->getId( $attributes[ 'id' ] );
}
return \Html::openElement( $tag, $attributes );
}
/**
* @param null|string $id
* @param null|mixed $component
* @return string
*/
public function getId( $id = null, $component = null ) {
if ( empty( $id ) ) {
// no specific id requested, just return a unique string
return base_convert( uniqid(), 16, 36 );
} elseif ( array_key_exists( $id, $this->mRegistry ) ) {
// specific id requested, but already in use
// return a string derived from the id and a unique string
$key = "$id-" . base_convert( uniqid(), 16, 36 );
$this->mRegistry[ $id ][ $key ] = $component;
return $key;
} else {
// specific id requested that is not yet in use
// return the id
$this->mRegistry[ $id ][ $id ] = $component;
return $id;
}
}
/**
* Returns an HTML element in a string. The contents are NOT escaped.
*
* The advantage over Html::rawElement is that any id attribute is ensured to be unique.
*
* @param string $tag
* @param array $attributes
* @param string $contents
*
* @return string
*/
public function element( $tag, $attributes = array(), $contents = '' ) {
if ( is_array( $attributes ) && isset( $attributes[ 'id' ] ) ) {
$attributes[ 'id' ] = $this->getId( $attributes[ 'id' ] );
}
return \Html::rawElement( $tag, $attributes, $contents );
}
}
|
