X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FContent%2FSmilies.php;h=39de3c20e04a6d74bcdbab0bc53c08c20fa96218;hb=cace4a8991575418e13a4212b20c220a5c8f227a;hp=464b5ee83ee28bad158025565c9bed59c610e832;hpb=be1333280765549860f9a7dc778a89acbd21dea6;p=friendica.git diff --git a/src/Content/Smilies.php b/src/Content/Smilies.php index 464b5ee83e..39de3c20e0 100644 --- a/src/Content/Smilies.php +++ b/src/Content/Smilies.php @@ -15,6 +15,7 @@ namespace Friendica\Content; use Friendica\App; +use Friendica\Core\Addon; use Friendica\Core\Config; use Friendica\Core\PConfig; use Friendica\Core\System; @@ -33,6 +34,8 @@ class Smilies * @param array $b Array of emoticons * @param string $smiley The text smilie * @param string $representation The replacement + * + * @return void */ public static function add(&$b, $smiley, $representation) { @@ -57,9 +60,9 @@ class Smilies * * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array) */ - public static function get_list() + public static function getList() { - $texts = array( + $texts = [ '<3', '</3', '<\\3', @@ -96,9 +99,9 @@ class Smilies 'red#', 'red#matrix' - ); + ]; - $icons = array( + $icons = [ '<3', '</3', '<\\3', @@ -134,16 +137,37 @@ class Smilies '~friendica ~friendica', 'redred#matrix', 'redred#matrixmatrix' - ); + ]; - $params = array('texts' => $texts, 'icons' => $icons); - call_hooks('smilie', $params); + $params = ['texts' => $texts, 'icons' => $icons]; + Addon::callHooks('smilie', $params); return $params; } + /** - * @brief Replaces text emoticons with graphical images + * Copied from http://php.net/manual/en/function.str-replace.php#88569 + * Modified for camel caps: renamed stro_replace -> strOrigReplace + * + * When using str_replace(...), values that did not exist in the original string (but were put there by previous + * replacements) will be replaced continuously. This string replacement function is designed to replace the values + * in $search with those in $replace while not factoring in prior replacements. Note that this function will + * always look for the longest possible match first and then work its way down to individual characters. + * + * @param array $search list of strings or characters that need to be replaced + * @param array $replace list of strings or characters that will replace the corresponding values in $search + * @param string $subject the string on which this operation is being performed + * + * @return string $subject with all substrings in the $search array replaced by the values in the $replace array + */ + private static function strOrigReplace($search, $replace, $subject) + { + return strtr($subject, array_combine($search, $replace)); + } + + /** + * Replaces text emoticons with graphical images * * It is expected that this function will be called using HTML text. * We will escape text between HTML pre and code blocks from being @@ -153,60 +177,78 @@ class Smilies * function from being executed by the prepare_text() routine when preparing * bbcode source for HTML display * + * @brief Replaces text emoticons with graphical images * @param string $s Text that should be replaced - * @param boolean $sample * @param boolean $no_images Only replace emoticons without images * - * @return string HML Output of the Smilie + * @return string HTML Output of the Smilie + */ + public static function replace($s, $no_images = false) + { + $smilies = self::getList(); + + $s = self::replaceFromArray($s, $smilies, $no_images); + + return $s; + } + + /** + * Replaces emoji shortcodes in a string from a structured array of searches and replaces. + * + * Depends on system.no_smilies config value, skips
 and  tags.
+	 *
+	 * @param string $text      An HTML string
+	 * @param array  $smilies   An string replacement array with the following structure: ['texts' => [], 'icons' => []]
+	 * @param bool   $no_images Only replace shortcodes without image replacement (e.g. Unicode characters)
+	 * @return string
 	 */
-	public static function replace($s, $sample = false, $no_images = false)
+	public static function replaceFromArray($text, array $smilies, $no_images = false)
 	{
 		if (intval(Config::get('system', 'no_smilies'))
 			|| (local_user() && intval(PConfig::get(local_user(), 'system', 'no_smilies')))
 		) {
-			return $s;
+			return $text;
 		}
 
-		$s = preg_replace_callback('/
(.*?)<\/pre>/ism', 'self::encode', $s);
-		$s = preg_replace_callback('/(.*?)<\/code>/ism', 'self::encode', $s);
-
-		$params = self::get_list();
+		$text = preg_replace_callback('/
(.*?)<\/pre>/ism'  , 'self::encode', $text);
+		$text = preg_replace_callback('/(.*?)<\/code>/ism', 'self::encode', $text);
 
 		if ($no_images) {
-			$cleaned = array('texts' => array(), 'icons' => array());
-			$icons = $params['icons'];
+			$cleaned = ['texts' => [], 'icons' => []];
+			$icons = $smilies['icons'];
 			foreach ($icons as $key => $icon) {
 				if (!strstr($icon, '
' . $params['icons'][$x] . '
'; - } - } else { - $params['string'] = preg_replace_callback('/<(3+)/', 'self::preg_heart', $params['string']); - $s = str_replace($params['texts'], $params['icons'], $params['string']); - } + $text = preg_replace_callback('/
(.*?)<\/pre>/ism', 'self::decode', $text);
+		$text = preg_replace_callback('/(.*?)<\/code>/ism', 'self::decode', $text);
 
-		$s = preg_replace_callback('/
(.*?)<\/pre>/ism', 'self::decode', $s);
-		$s = preg_replace_callback('/(.*?)<\/code>/ism', 'self::decode', $s);
-
-		return $s;
+		return $text;
 	}
 
+	/**
+	 * @param string $m string
+	 *
+	 * @return string base64 encoded string
+	 */
 	private static function encode($m)
 	{
 		return(str_replace($m[1], base64url_encode($m[1]), $m[0]));
 	}
 
+	/**
+	 * @param string $m string
+	 *
+	 * @return string base64 decoded string
+	 */
 	private static function decode($m)
 	{
 		return(str_replace($m[1], base64url_decode($m[1]), $m[0]));
@@ -216,13 +258,13 @@ class Smilies
 	/**
 	 * @brief expand <3333 to the correct number of hearts
 	 *
-	 * @param string $x
+	 * @param string $x string
 	 *
 	 * @return string HTML Output
 	 *
 	 * @todo: Rework because it doesn't work correctly
 	 */
-	private static function preg_heart($x)
+	private static function pregHeart($x)
 	{
 		if (strlen($x[1]) == 1) {
 			return $x[0];