Add get method to CharacterCollection + add Exception + update PHPDocs

src/Character.php

@@ -10,34 +10,22 @@ class Character
     /** @var array */
     private $positions;
 
-    /**
-     * @param string $value
-     */
     public function __construct(string $value)
     {
         $this->value = $value;
     }
 
-    /**
-     * @param int $position
-     */
     public function addPosition(int $position)
     {
         $this->positions[] = $position;
     }
 
-    /**
-     * @return array
-     */
-    public function getPositions()
+    public function getPositions(): array
     {
         return $this->positions;
     }
 
-    /**
-     * @return string
-     */
-    public function getValue()
+    public function getValue(): string
     {
         return $this->value;
     }

src/CharacterCollection.php

@@ -7,9 +7,6 @@ class CharacterCollection
     /** @var array */
     private $characters;
 
-    /**
-     * @param string $sentence
-     */
     public function __construct(string $sentence)
     {
         /** @var array $characters */
@@ -20,11 +17,21 @@ public function __construct(string $sentence)
         }
     }
 
-    /**
-     * @param int $position
-     * @param string $character
-     */
-    public function add(int $position, string $character)
+    public function __toString(): string
+    {
+        $sentences = [];
+        foreach ($this->characters as $position => $character) {
+            foreach ($character->getPositions() as $position) {
+                $sentences[$position] = $character->getValue();
+            }
+        }
+
+        ksort($sentences);
+
+        return implode($sentences);
+    }
+
+    public function add(int $position, string $character): void
     {
         if ($character === '') {
             return;
@@ -37,20 +44,12 @@ public function add(int $position, string $character)
         $this->characters[$character]->addPosition($position);
     }
 
-    /**
-     * @return string
-     */
-    public function __toString(): string
+    public function get(string $character): Character
     {
-        $sentences = [];
-        foreach ($this->characters as $position => $character) {
-            foreach ($character->getPositions() as $position) {
-                $sentences[$position] = $character->getValue();
-            }
+        if (!array_key_exists($character, $this->characters)) {
+            throw Exception::characterNotFound($character);
         }
 
-        ksort($sentences);
-
-        return implode($sentences);
+        return $this->characters[$character];
     }
 }

src/Exception.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace JeroenDesloovere\CharacterCollection;
+
+class Exception extends \Exception
+{
+    public static function characterNotFound(string $character): \Exception
+    {
+        return new self('Character ' . $character . ' not found.');
+    }
+}