Can now keep inputted case

Author: LasseRafn

src/Initials.php

@@ -4,9 +4,10 @@
 
 class Initials
 {
-    private $parameter_length = 2;
-    private $parameter_initials = 'JD';
-    private $parameter_name = 'John Doe';
+    private $length = 2;
+    private $initials = 'JD';
+    private $keepCase = false;
+    private $name = 'John Doe';
 
     /**
      * Set the name used for generating initials.
@@ -22,6 +23,21 @@ public function name($nameOrInitials)
         return $this;
     }
 
+    /**
+     * Set if should keep lettercase on name.
+     * Setting this to false (default) will uppercase the name.
+     *
+     * @param boolean $keepCase
+     *
+     * @return Initials
+     */
+    public function keepCase($keepCase = true)
+    {
+        $this->keepCase = $keepCase;
+
+        return $this;
+    }
+
     /**
      * Set the length of the generated initials.
      *
@@ -31,8 +47,8 @@ public function name($nameOrInitials)
      */
     public function length($length = 2)
     {
-        $this->parameter_length = (int) $length;
-        $this->parameter_initials = $this->generateInitials();
+        $this->length = (int) $length;
+        $this->initials = $this->generateInitials();
 
         return $this;
     }
@@ -47,8 +63,8 @@ public function length($length = 2)
     public function generate($name = null)
     {
         if ($name !== null) {
-            $this->parameter_name = $name;
-            $this->parameter_initials = $this->generateInitials();
+            $this->name = $name;
+            $this->initials = $this->generateInitials();
         }
 
         return (string) $this;
@@ -61,7 +77,7 @@ public function generate($name = null)
      */
     public function getInitials()
     {
-        return $this->parameter_initials;
+        return $this->initials;
     }
 
     /**
@@ -74,7 +90,7 @@ public function getUrlfriendlyInitials()
     {
         $urlFriendlyInitials = $this->convertToUrlFriendlyString($this->getInitials());
 
-        $urlFriendlyInitials = mb_substr($urlFriendlyInitials, 0, $this->parameter_length);
+        $urlFriendlyInitials = mb_substr($urlFriendlyInitials, 0, $this->length);
 
         return $urlFriendlyInitials;
     }
@@ -99,7 +115,12 @@ public function __toString()
      */
     private function generateInitials()
     {
-        $nameOrInitials = mb_strtoupper(trim($this->parameter_name));
+	    $nameOrInitials = trim($this->name);
+
+    	if( !$this->keepCase ) {
+		    $nameOrInitials = mb_strtoupper($nameOrInitials);
+	    }
+
         $names = explode(' ', $nameOrInitials);
         $initials = $nameOrInitials;
         $assignedNames = 0;
@@ -108,10 +129,10 @@ private function generateInitials()
             $initials = '';
             $start = 0;
 
-            for ($i = 0; $i < $this->parameter_length; $i++) {
+            for ($i = 0; $i < $this->length; $i++) {
                 $index = $i;
 
-                if (($index === ($this->parameter_length - 1) && $index > 0) || ($index > (count($names) - 1))) {
+                if (($index === ($this->length - 1) && $index > 0) || ($index > (count($names) - 1))) {
                     $index = count($names) - 1;
                 }
 
@@ -124,7 +145,7 @@ private function generateInitials()
             }
         }
 
-        $initials = mb_substr($initials, 0, $this->parameter_length);
+        $initials = mb_substr($initials, 0, $this->length);
 
         return $initials;
     }

tests/InitialCaseTest.php

@@ -0,0 +1,16 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class InitialCaseTest extends TestCase
+{
+    public function testCanPreventUppercase()
+    {
+        $avatar = new \LasseRafn\Initials\Initials();
+
+        $avatar->name('lRa')->keepCase()->length(3);
+
+        $this->assertEquals('lRa', $avatar->getInitials());
+        $this->assertEquals(3, strlen($avatar->getInitials()));
+    }
+}