Use type hints instead of manual type checking. Unify exception messages

Imangazaliev · May 8, 2022 · ff5c7f1 · ff5c7f1
1 parent f0de722
commit ff5c7f1
Show file tree

Hide file tree

Showing 19 changed files with 475 additions and 939 deletions.
diff --git a/src/DiDom/ClassAttribute.php b/src/DiDom/ClassAttribute.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace DiDom;
 
 use InvalidArgumentException;
@@ -31,7 +33,7 @@ class ClassAttribute
     public function __construct(Element $element)
     {
         if ( ! $element->isElementNode()) {
-            throw new InvalidArgumentException(sprintf('The element must contain DOMElement node'));
+            throw new InvalidArgumentException(sprintf('The element must contain DOMElement node.'));
         }
 
         $this->element = $element;
@@ -96,12 +98,8 @@ protected function updateClassAttribute()
      *
      * @throws InvalidArgumentException if class name is not a string
      */
-    public function add($className)
+    public function add(string $className): self
     {
-        if ( ! is_string($className)) {
-            throw new InvalidArgumentException(sprintf('%s expects parameter 1 to be string, %s given', __METHOD__, (is_object($className) ? get_class($className) : gettype($className))));
-        }
-
         $this->parseClassAttribute();
 
         if (in_array($className, $this->classes, true)) {
@@ -122,13 +120,13 @@ public function add($className)
      *
      * @throws InvalidArgumentException if class name is not a string
      */
-    public function addMultiple(array $classNames)
+    public function addMultiple(array $classNames): self
     {
         $this->parseClassAttribute();
 
         foreach ($classNames as $className) {
             if ( ! is_string($className)) {
-                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given', (is_object($className) ? get_class($className) : gettype($className))));
+                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given.', (is_object($className) ? get_class($className) : gettype($className))));
             }
 
             if (in_array($className, $this->classes, true)) {
@@ -146,7 +144,7 @@ public function addMultiple(array $classNames)
     /**
      * @return string[]
      */
-    public function getAll()
+    public function getAll(): array
     {
         $this->parseClassAttribute();
 
@@ -158,12 +156,8 @@ public function getAll()
      *
      * @return bool
      */
-    public function contains($className)
+    public function contains(string $className): bool
     {
-        if ( ! is_string($className)) {
-            throw new InvalidArgumentException(sprintf('%s expects parameter 1 to be string, %s given', __METHOD__, (is_object($className) ? get_class($className) : gettype($className))));
-        }
-
         $this->parseClassAttribute();
 
         return in_array($className, $this->classes, true);
@@ -176,12 +170,8 @@ public function contains($className)
      *
      * @throws InvalidArgumentException if class name is not a string
      */
-    public function remove($className)
+    public function remove(string $className): self
     {
-        if ( ! is_string($className)) {
-            throw new InvalidArgumentException(sprintf('%s expects parameter 1 to be string, %s given', __METHOD__, (is_object($className) ? get_class($className) : gettype($className))));
-        }
-
         $this->parseClassAttribute();
 
         $classIndex = array_search($className, $this->classes);
@@ -204,13 +194,13 @@ public function remove($className)
      *
      * @throws InvalidArgumentException if class name is not a string
      */
-    public function removeMultiple(array $classNames)
+    public function removeMultiple(array $classNames): self
     {
         $this->parseClassAttribute();
 
         foreach ($classNames as $className) {
             if ( ! is_string($className)) {
-                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given', (is_object($className) ? get_class($className) : gettype($className))));
+                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given.', (is_object($className) ? get_class($className) : gettype($className))));
             }
 
             $classIndex = array_search($className, $this->classes);
@@ -232,15 +222,15 @@ public function removeMultiple(array $classNames)
      *
      * @return ClassAttribute
      */
-    public function removeAll(array $exclusions = [])
+    public function removeAll(array $exclusions = []): self
     {
         $this->parseClassAttribute();
 
         $preservedClasses = [];
 
         foreach ($exclusions as $className) {
             if ( ! is_string($className)) {
-                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given', (is_object($className) ? get_class($className) : gettype($className))));
+                throw new InvalidArgumentException(sprintf('Class name must be a string, %s given.', (is_object($className) ? get_class($className) : gettype($className))));
             }
 
             if ( ! in_array($className, $this->classes, true)) {
@@ -260,7 +250,7 @@ public function removeAll(array $exclusions = [])
     /**
      * @return Element
      */
-    public function getElement()
+    public function getElement(): Element
     {
         return $this->element;
     }