From 2d43e94b72b5bd40a6396176bd2baf4c14fb0ca9 Mon Sep 17 00:00:00 2001
From: Nate Nolting <me@natenolting.com>
Date: Tue, 23 Oct 2018 13:23:05 -0500
Subject: [PATCH] Added superscript HTML helper

Wrap special characters that should be super scripted with the <sup> tag.
---
 src/Bandolier/Type/Html/SpecialCharacter.php | 40 ++++++++++++++++++++
 tests/Type/Html/SpecialCharacterTest.php     | 26 +++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 src/Bandolier/Type/Html/SpecialCharacter.php
 create mode 100644 tests/Type/Html/SpecialCharacterTest.php

diff --git a/src/Bandolier/Type/Html/SpecialCharacter.php b/src/Bandolier/Type/Html/SpecialCharacter.php
new file mode 100644
index 0000000..79b7aa4
--- /dev/null
+++ b/src/Bandolier/Type/Html/SpecialCharacter.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Pbc\Bandolier\Type\Html;
+
+use Pbc\Bandolier\Type\BaseType;
+
+class SpecialCharacter extends BaseType
+{
+    /**
+     * Superscript special characters
+     * @see https://en.wikipedia.org/wiki/Registered_trademark_symbol#Related_symbols
+     * @param $string string to modify
+     * @param array $characters List of characters to find and apply superscript
+     * @return string
+     */
+    public static function superscriptSpecialCharacters($string, array $characters = []) {
+
+        $defaults = [
+            'registered' => ['®', '&reg;', '&#x00AE;', '&#174;'],
+            'trademark'  => ['™', '&trade;', '&#8482;'],
+            'copyright'  => ['©', '&#169;', '&copy;'],
+            'service'    => ['℠', '&#8480;'],
+            'phonogram'  => ['℗', '&#8471;'],
+            'hechsher'   => ['Ⓤ', '&#9418;']
+        ];
+        $characters = array_merge($defaults, $characters);
+        $specials = array();
+        array_walk_recursive($characters, function ($v) use (&$specials) {
+            $specials[] = $v;
+        });
+        // wrap all the special characters above with superscript tags
+        for ($i = 0, $iCount = count($specials); $i < $iCount; $i++) {
+            if (strpos($string, $specials[0]) !== false) {
+                $string = str_replace($specials[$i], '<sup>' . $specials[$i] . '</sup>', $string);
+            }
+        }
+
+        return $string;
+    }
+}
\ No newline at end of file
diff --git a/tests/Type/Html/SpecialCharacterTest.php b/tests/Type/Html/SpecialCharacterTest.php
new file mode 100644
index 0000000..62eeabc
--- /dev/null
+++ b/tests/Type/Html/SpecialCharacterTest.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * ${CLASS_NAME}
+ *
+ * Created 10/23/18 1:16 PM
+ * Description of this file here....
+ *
+ * @author Nate Nolting <naten@paulbunyan.net>
+ * @package Pbc\Bandolier\Type\Html
+ * @subpackage Subpackage
+ */
+
+namespace Pbc\Bandolier\Type\Html;
+
+
+class SpecialCharacterTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testSuperscriptSpecialCharacters()
+    {
+        $string = "This® Thing™ is©";
+        $stringAfter = "This<sup>®</sup> Thing<sup>™</sup> is<sup>©</sup>";
+
+        $this->assertSame($stringAfter, SpecialCharacter::superscriptSpecialCharacters($string));
+    }
+}