Option to disable special characters

Author: LasseRafn

src/Initials.php

@@ -4,10 +4,11 @@
 
 class Initials
 {
-    private $length = 2;
-    private $initials = 'JD';
-    private $keepCase = false;
-    private $name = 'John Doe';
+    protected $length = 2;
+    protected $initials = 'JD';
+    protected $keepCase = false;
+    protected $allowSpecialCharacters = true;
+    protected $name = 'John Doe';
 
     /**
      * Set the name used for generating initials.
@@ -38,6 +39,20 @@ public function keepCase($keepCase = true)
         return $this;
     }
 
+    /**
+     * Set if should allow (or remove) special characters.
+     *
+     * @param boolean $allowSpecialCharacters
+     *
+     * @return Initials
+     */
+    public function allowSpecialCharacters($allowSpecialCharacters = true)
+    {
+        $this->allowSpecialCharacters = $allowSpecialCharacters;
+
+        return $this;
+    }
+
     /**
      * Set the length of the generated initials.
      *
@@ -113,15 +128,32 @@ public function __toString()
      *
      * @return string
      */
-    private function generateInitials()
+    protected function generateInitials()
     {
 	    $nameOrInitials = trim($this->name);
 
     	if( !$this->keepCase ) {
 		    $nameOrInitials = mb_strtoupper($nameOrInitials);
 	    }
 
+    	if( !$this->allowSpecialCharacters ) {
+    		$nameOrInitials = preg_replace('/[!@#$%^&*(),.?":{}|<>_]/', '', $nameOrInitials);
+	    }
+
+	    $nameOrInitials = trim( trim( $nameOrInitials, '-' ) );
+
         $names = explode(' ', $nameOrInitials);
+
+	    // Get names with dash (-) between into separate names
+	    $names = array_map( static function ($namePart) { return explode('-', $namePart); }, $names );
+	    $realNames = [];
+
+	    foreach( new \RecursiveIteratorIterator( new \RecursiveArrayIterator($names) ) as $namePart ) {
+		    $realNames[] = $namePart;
+	    }
+
+	    $names = $realNames;
+
         $initials = $nameOrInitials;
         $assignedNames = 0;
 
@@ -159,7 +191,7 @@ private function generateInitials()
      *
      * @return string
      */
-    private function convertToUrlFriendlyString($string)
+    protected function convertToUrlFriendlyString($string)
     {
         foreach (static::charsArray() as $key => $val) {
             $string = str_replace($val, mb_substr($key, 0, 1), $string);

tests/SpecialCharactersTest.php

@@ -0,0 +1,20 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class SpecialCharactersTest extends TestCase
+{
+	public function testDoesNotIncludeSpecialCharactersByDefault() {
+		// without new feature
+		$this->assertEquals( 'J(', ( new \LasseRafn\Initials\Initials )->name( 'John Doe (Anderson)' )->getInitials() );
+
+		// With new feature
+		$this->assertEquals( 'JA', ( new \LasseRafn\Initials\Initials )->allowSpecialCharacters( false )->name( 'John Doe (Anderson)' )->getInitials() );
+		$this->assertEquals( 'JD', ( new \LasseRafn\Initials\Initials )->allowSpecialCharacters( false )->name( 'John (Doe)' )->getInitials() );
+
+		$this->assertEquals( 'JD', ( new \LasseRafn\Initials\Initials )->allowSpecialCharacters( false )->name( 'John (!Doe$ !--' )->getInitials() );
+		$this->assertEquals( 'JG', ( new \LasseRafn\Initials\Initials )->allowSpecialCharacters( false )->name( 'John Mc-Guire' )->getInitials() );
+
+		$this->assertEquals( 'JMG', ( new \LasseRafn\Initials\Initials )->allowSpecialCharacters( false )->name( 'John Mc-Guire' )->length( 3 )->getInitials() );
+	}
+}