Merge branch '3.0'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / util / StringStack.class.php

<?php
namespace wcf\util;

/**
 * Replaces quoted strings in a text.
 * 
 * @author	Marcel Werk
 * @copyright	2001-2018 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\Util
 */
final class StringStack {
	/**
	 * hash index
	 * @var	integer
	 */
	protected static $i = 0;
	
	/**
	 * local string stack
	 * @var	string[][]
	 */
	protected static $stringStack = [];
	
	/**
	 * Replaces a string with an unique hash value.
	 * 
	 * @param	string		$string
	 * @param	string		$type
	 * @return	string		$hash
	 * @param	string		$delimiter
	 */
	public static function pushToStringStack($string, $type = 'default', $delimiter = '@@') {
		self::$i++;
		$hash = $delimiter.StringUtil::getHash(self::$i.uniqid(microtime()).$string).$delimiter;
		
		if (!isset(self::$stringStack[$type])) {
			self::$stringStack[$type] = [];
		}
		
		self::$stringStack[$type][$hash] = $string;
		
		return $hash;
	}
	
	/**
	 * Reinserts strings that have been replaced by unique hash values.
	 * 
	 * @param	string		$string
	 * @param	string		$type
	 * @return	string
	 */
	public static function reinsertStrings($string, $type = 'default') {
		if (isset(self::$stringStack[$type])) {
			foreach (self::$stringStack[$type] as $hash => $value) {
				if (mb_strpos($string, $hash) !== false) {
					$string = str_replace($hash, $value, $string);
					unset(self::$stringStack[$type][$hash]);
				}
			}
		}
		
		return $string;
	}
	
	/**
	 * Returns the stack.
	 * 
	 * @param	string		$type
	 * @return	array
	 */
	public static function getStack($type = 'default') {
		if (isset(self::$stringStack[$type])) {
			return self::$stringStack[$type];
		}
		
		return [];
	}
	
	/**
	 * Forbid creation of StringStack objects.
	 */
	private function __construct() {
		// does nothing
	}
}