Add parameter and return type hints.

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### 3.0.0 (2020-08-25)
 
 - **[BC]** Drop support for PHP 7.1
+- **[Bc]** Add parameter and return type hints
 - **[BC]** Remove `PackageInfo` class
 - **[BC]** Rename `ComparatorInterface` to `Comparator`
 - **[BC]** Rename `AnyComparableInterface` to `AnyComparable`

composer.json

@@ -27,7 +27,7 @@
     "require-dev": {
         "eloquent/liberator": "^2",
         "friendsofphp/php-cs-fixer": "^2",
-        "phake/phake": "^1",
+        "phake/phake": "^3",
         "phpunit/phpunit": "^8"
     },
     "autoload": { "psr-4": { "Icecave\\Parity\\": "src" } },

src/AnyComparable.php

@@ -23,5 +23,5 @@ interface AnyComparable
      *
      * @return int The result of the comparison.
      */
-    public function compare($value);
+    public function compare($value): int;
 }

src/Comparator/Comparator.php

@@ -23,7 +23,7 @@ interface Comparator
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs);
+    public function compare($lhs, $rhs): int;
 
     /**
      * An alias for compare().
@@ -33,5 +33,5 @@ public function compare($lhs, $rhs);
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs);
+    public function __invoke($lhs, $rhs): int;
 }

src/Comparator/DeepComparator.php

@@ -31,7 +31,7 @@ public function __construct(
      *
      * @return Comparator The comparator to use when the operands are not arrays or objects.
      */
-    public function fallbackComparator()
+    public function fallbackComparator(): Comparator
     {
         return $this->fallbackComparator;
     }
@@ -55,7 +55,7 @@ public function fallbackComparator()
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs)
+    public function compare($lhs, $rhs): int
     {
         $visitationContext = [];
 
@@ -70,7 +70,7 @@ public function compare($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs)
+    public function __invoke($lhs, $rhs): int
     {
         return $this->compare($lhs, $rhs);
     }
@@ -82,7 +82,7 @@ public function __invoke($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    protected function compareValue($lhs, $rhs, &$visitationContext)
+    protected function compareValue($lhs, $rhs, &$visitationContext): int
     {
         if (is_array($lhs) && is_array($rhs)) {
             return $this->compareArray($lhs, $rhs, $visitationContext);
@@ -100,7 +100,7 @@ protected function compareValue($lhs, $rhs, &$visitationContext)
      *
      * @return int The result of the comparison.
      */
-    protected function compareArray(array $lhs, array $rhs, &$visitationContext)
+    protected function compareArray(array $lhs, array $rhs, &$visitationContext): int
     {
         reset($lhs);
         reset($rhs);
@@ -144,7 +144,7 @@ protected function compareArray(array $lhs, array $rhs, &$visitationContext)
      *
      * @return int The result of the comparison.
      */
-    protected function compareObject($lhs, $rhs, &$visitationContext)
+    protected function compareObject($lhs, $rhs, &$visitationContext): int
     {
         if ($lhs === $rhs) {
             return 0;
@@ -173,7 +173,7 @@ protected function compareObject($lhs, $rhs, &$visitationContext)
      *
      * @return array<string,mixed>
      */
-    protected function objectProperties($object, &$visitationContext)
+    protected function objectProperties($object, &$visitationContext): array
     {
         $properties = [];
         $reflector = new ReflectionObject($object);
@@ -207,7 +207,7 @@ protected function objectProperties($object, &$visitationContext)
      *
      * @return bool
      */
-    protected function isNestedComparison($lhs, $rhs, &$visitationContext)
+    protected function isNestedComparison($lhs, $rhs, &$visitationContext): bool
     {
         $key = spl_object_hash($lhs) . ':' . spl_object_hash($rhs);
 

src/Comparator/ObjectIdentityComparator.php

@@ -20,7 +20,7 @@ public function __construct(Comparator $fallbackComparator)
      *
      * @return Comparator The comparator to use for non-objects.
      */
-    public function fallbackComparator()
+    public function fallbackComparator(): Comparator
     {
         return $this->fallbackComparator;
     }
@@ -44,7 +44,7 @@ public function fallbackComparator()
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs)
+    public function compare($lhs, $rhs): int
     {
         if (!is_object($lhs) || !is_object($rhs)) {
             return $this->fallbackComparator()->compare($lhs, $rhs);
@@ -65,7 +65,7 @@ public function compare($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs)
+    public function __invoke($lhs, $rhs): int
     {
         return $this->compare($lhs, $rhs);
     }

src/Comparator/ParityComparator.php

@@ -28,7 +28,7 @@ public function __construct(Comparator $fallbackComparator)
      *
      * @return Comparator The comparator to use when the operands do not provide their own comparison algorithm.
      */
-    public function fallbackComparator()
+    public function fallbackComparator(): Comparator
     {
         return $this->fallbackComparator;
     }
@@ -55,7 +55,7 @@ public function fallbackComparator()
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs)
+    public function compare($lhs, $rhs): int
     {
         if ($this->canCompare($lhs, $rhs)) {
             return $lhs->compare($rhs);
@@ -74,7 +74,7 @@ public function compare($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs)
+    public function __invoke($lhs, $rhs): int
     {
         return $this->compare($lhs, $rhs);
     }
@@ -87,7 +87,7 @@ public function __invoke($lhs, $rhs)
      *
      * @return bool
      */
-    protected function canCompare($lhs, $rhs)
+    protected function canCompare($lhs, $rhs): bool
     {
         if ($lhs instanceof AnyComparable) {
             return true;
@@ -110,7 +110,7 @@ protected function canCompare($lhs, $rhs)
      *
      * @return string
      */
-    protected function compareImplementationClass($value)
+    protected function compareImplementationClass($value): string
     {
         $className = get_class($value);
 

src/Comparator/PhpComparator.php

@@ -23,7 +23,7 @@ class PhpComparator implements Comparator
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs)
+    public function compare($lhs, $rhs): int
     {
         if ($lhs < $rhs) {
             return -1;
@@ -42,7 +42,7 @@ public function compare($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs)
+    public function __invoke($lhs, $rhs): int
     {
         return $this->compare($lhs, $rhs);
     }

src/Comparator/StrictPhpComparator.php

@@ -36,7 +36,7 @@ public function __construct($relaxNumericComparisons = true)
      *
      * @return int The result of the comparison.
      */
-    public function compare($lhs, $rhs)
+    public function compare($lhs, $rhs): int
     {
         $lhsType = $this->transformTypeName($lhs);
         $rhsType = $this->transformTypeName($rhs);
@@ -61,7 +61,7 @@ public function compare($lhs, $rhs)
      *
      * @return int The result of the comparison.
      */
-    public function __invoke($lhs, $rhs)
+    public function __invoke($lhs, $rhs): int
     {
         return $this->compare($lhs, $rhs);
     }
@@ -71,7 +71,7 @@ public function __invoke($lhs, $rhs)
      *
      * @return string The effective type name to use when comparing types.
      */
-    private function transformTypeName($value)
+    private function transformTypeName($value): string
     {
         if (is_object($value)) {
             return 'object:' . get_class($value);

src/ExtendedComparable.php

@@ -12,40 +12,40 @@ interface ExtendedComparable
      *
      * @return bool True if $this == $value.
      */
-    public function isEqualTo($value);
+    public function isEqualTo($value): bool;
 
     /**
      * @param mixed $value The value to compare.
      *
      * @return bool True if $this != $value.
      */
-    public function isNotEqualTo($value);
+    public function isNotEqualTo($value): bool;
 
     /**
      * @param mixed $value The value to compare.
      *
      * @return bool True if $this < $value.
      */
-    public function isLessThan($value);
+    public function isLessThan($value): bool;
 
     /**
      * @param mixed $value The value to compare.
      *
      * @return bool True if $this > $value.
      */
-    public function isGreaterThan($value);
+    public function isGreaterThan($value): bool;
 
     /**
      * @param mixed $value The value to compare.
      *
      * @return bool True if $this <= $value.
      */
-    public function isLessThanOrEqualTo($value);
+    public function isLessThanOrEqualTo($value): bool;
 
     /**
      * @param mixed $value The value to compare.
      *
      * @return bool True if $this >= $value.
      */
-    public function isGreaterThanOrEqualTo($value);
+    public function isGreaterThanOrEqualTo($value): bool;
 }