use enum for world peace

Author: ianardee

src/Geometry/BBox.php

@@ -85,10 +85,10 @@ public function getMaxY(): float
     /**
      * Extends the BBox with the provided points.
      *
-     * @param Polygon|array $points Series of points to add to the BBox.
+     * @param array|Polygon $points Series of points to add to the BBox.
      * @return void
      */
-    public function extendWith($points)
+    public function extendWith(Polygon|array $points): void
     {
         if ($points instanceof Polygon) {
             $sequence = $points->getCoordinates();

src/Parsing/Standard/BaseField.php

@@ -2,12 +2,6 @@
 
 namespace Mindee\Parsing\Standard;
 
-use Mindee\Geometry\BBox;
-use Mindee\Geometry\Point;
-use Mindee\Geometry\Polygon;
-
-use function Mindee\Geometry\createBoundingBoxFrom;
-
 /**
  * Base class for most fields.
  */
@@ -57,7 +51,7 @@ public function __construct(
     /**
      * Compares with the value of another field.
      *
-     * @param \Mindee\Parsing\Standard\BaseField $obj Field to compare.
+     * @param BaseField $obj Field to compare.
      * @return boolean
      */
     public function __compare(BaseField $obj): bool

src/Parsing/Standard/StringField.php

@@ -17,7 +17,7 @@ class StringField extends BaseField
     /**
      * @var string|null The value as it appears on the document.
      */
-    public $rawValue;
+    public string|null $rawValue;
 
 
     /**

src/Parsing/V2/Field/BaseField.php

@@ -37,30 +37,27 @@ public function __construct(array $rawPrediction, int $indentLevel = 0)
             }
         }
         if (array_key_exists("confidence", $rawPrediction) && $rawPrediction["confidence"]) {
-            $this->confidence = new FieldConfidence($rawPrediction["confidence"]);
+            $this->confidence = FieldConfidence::from($rawPrediction["confidence"]);
         }
     }
 
     /**
      * @param array   $rawPrediction Raw prediction array.
      * @param integer $indentLevel   Level of indentation for rst display.
-     * @return BaseField
+     * @return ListField|ObjectField|SimpleField
      * @throws MindeeApiException Throws if the field type isn't recognized.
      */
-    public static function createField(array $rawPrediction, int $indentLevel = 0)
+    public static function createField(array $rawPrediction, int $indentLevel = 0): ListField|ObjectField|SimpleField
     {
         if (array_key_exists('items', $rawPrediction)) {
             return new ListField($rawPrediction, $indentLevel);
         }
-
         if (array_key_exists('fields', $rawPrediction)) {
             return new ObjectField($rawPrediction, $indentLevel);
         }
-
         if (array_key_exists('value', $rawPrediction)) {
             return new SimpleField($rawPrediction, $indentLevel);
         }
-
         throw new MindeeApiException(
             sprintf('Unrecognized field format in %s.', json_encode($rawPrediction))
         );

src/Parsing/V2/Field/FieldConfidence.php

@@ -2,74 +2,10 @@
 
 namespace Mindee\Parsing\V2\Field;
 
-use InvalidArgumentException;
-
-/**
- * Confidence level of a field as returned by the V2 API.
- */
-class FieldConfidence
+enum FieldConfidence: string
 {
-    public const CERTAIN = 'Certain';
-    public const HIGH = 'High';
-    public const MEDIUM = 'Medium';
-    public const LOW = 'Low';
-
-    /**
-     * @var string
-     */
-    private string $value;
-
-    /**
-     * @param string $value Vale provided.
-     * @throws InvalidArgumentException Throws if an invalid value is provided.
-     */
-    public function __construct(string $value)
-    {
-        if (!self::isValid($value)) {
-            throw new InvalidArgumentException(sprintf(
-                'Invalid confidence value "%s". Valid values are: %s',
-                $value,
-                implode(', ', self::getValidValues())
-            ));
-        }
-        $this->value = $value;
-    }
-
-    /**
-     * @param string $value Value to check.
-     * @return boolean True if the value is valid.
-     */
-    public static function isValid(string $value): bool
-    {
-        return in_array($value, self::getValidValues(), true);
-    }
-
-    /**
-     * @return array<string>
-     */
-    public static function getValidValues(): array
-    {
-        return [
-            self::CERTAIN,
-            self::HIGH,
-            self::MEDIUM,
-            self::LOW,
-        ];
-    }
-
-    /**
-     * @return string String representation.
-     */
-    public function getValue(): string
-    {
-        return $this->value;
-    }
-
-    /**
-     * @return string
-     */
-    public function __toString(): string
-    {
-        return $this->value;
-    }
+    case Certain = 'Certain';
+    case High = 'High';
+    case Medium = 'Medium';
+    case Low = 'Low';
 }

tests/Parsing/V2/InferenceTest.php

@@ -335,7 +335,7 @@ public function testCoordinatesAndLocationDataMustBeAccessible(): void
             new Point(0.9015345, 0.23731850000000002),
             $location->polygon->getCentroid()
         );
-        $this->assertEquals(FieldConfidence::MEDIUM, $dateField->confidence);
-        $this->assertEquals('Medium', $dateField->confidence->getValue());
+        $this->assertEquals(FieldConfidence::Medium, $dateField->confidence);
+        $this->assertEquals('Medium', $dateField->confidence->value);
     }
 }