diff options
author | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
---|---|---|
committer | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
commit | fc7369835258467bf97eb64f184b93691f9a9fd5 (patch) | |
tree | daabd60089d2dd76d9f5fb416b005fbe159c799d /www/wiki/skins/chameleon/src/IdRegistry.php |
first commit
Diffstat (limited to 'www/wiki/skins/chameleon/src/IdRegistry.php')
-rw-r--r-- | www/wiki/skins/chameleon/src/IdRegistry.php | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/www/wiki/skins/chameleon/src/IdRegistry.php b/www/wiki/skins/chameleon/src/IdRegistry.php new file mode 100644 index 00000000..11a880d4 --- /dev/null +++ b/www/wiki/skins/chameleon/src/IdRegistry.php @@ -0,0 +1,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 ); + } +} |