minor tweaks

Author: ianardee

src/Geometry/MinMaxUtils.php

@@ -2,6 +2,8 @@
 
 namespace Mindee\Geometry;
 
+use Mindee\Error\MindeeGeometryException;
+
 /**
  * Utility class for MinMax.
  */
@@ -11,31 +13,41 @@ class MinMaxUtils
      * Retrieves the upper and lower bounds of the y-axis from an array of points.
      *
      * @param array $points An array of points.
-     * @return \Mindee\Geometry\MinMax
+     * @return MinMax
+     * @throws MindeeGeometryException Throws if the provided array is too small.
      */
     public static function getMinMaxY(array $points): MinMax
     {
+        if (count($points) < 1) {
+            throw new MindeeGeometryException(
+                'The provided point array must have at least 1 point to calculate the Y bounds.'
+            );
+        }
         $yCoords = [];
         foreach ($points as $point) {
             $yCoords[] = $point->getY();
         }
-
         return new MinMax(min($yCoords), max($yCoords));
     }
 
     /**
      * Retrieves the upper and lower bounds of the x-axis from an array of points.
      *
      * @param array $points An array of points.
-     * @return \Mindee\Geometry\MinMax
+     * @return MinMax
+     * @throws MindeeGeometryException Throws if the provided array is too small.
      */
     public static function getMinMaxX(array $points): MinMax
     {
+        if (count($points) < 1) {
+            throw new MindeeGeometryException(
+                'The provided point array must have at least 1 point to calculate the X bounds.'
+            );
+        }
         $xCoords = [];
         foreach ($points as $point) {
             $xCoords[] = $point->getX();
         }
-
         return new MinMax(min($xCoords), max($xCoords));
     }
 }

src/Input/LocalInputSource.php

@@ -9,13 +9,10 @@
 use CURLFile;
 use Exception;
 use Mindee\Error\ErrorCode;
-use Mindee\Error\MindeeImageException;
 use Mindee\Error\MindeeMimeTypeException;
 use Mindee\Error\MindeePDFException;
 use Mindee\Error\MindeeSourceException;
-use Mindee\Error\MindeeUnhandledException;
 use Mindee\Image\ImageCompressor;
-use Mindee\Parsing\DependencyChecker;
 use Mindee\PDF\PDFCompressor;
 use Mindee\PDF\PDFUtils;
 use setasign\Fpdi\Fpdi;
@@ -131,27 +128,11 @@ public function countDocPages(): int
         }
     }
 
-    /**
-     * Processes a PDF file.
-     * To be implemented.
-     *
-     * @param string  $behavior    Behaviors available: KEEP_ONLY, REMOVE.
-     * @param integer $onMinPages  Minimum of pages to apply the operation.
-     * @param array   $pageIndexes Indexes of the pages to apply the operation to.
-     * @return void
-     * @throws MindeePDFException Throws if the operation is unknown, or if the resulting PDF can't be processed.
-     * @deprecated Use applyPageOptions() instead.
-     */
-    public function processPDF(string $behavior, int $onMinPages, array $pageIndexes)
-    {
-        $this->applyPageOptions(new PageOptions($pageIndexes, $behavior, $onMinPages));
-    }
-
     /**
      * @param string $fileBytes Raw data as bytes.
      * @return void
      */
-    private function saveBytesAsFile(string $fileBytes)
+    private function saveBytesAsFile(string $fileBytes): void
     {
         $cutPdfTempFile = tempnam(sys_get_temp_dir(), 'mindee_cut_pdf_');
         file_put_contents($cutPdfTempFile, $fileBytes);

src/Parsing/Common/Ocr/OcrPage.php

@@ -2,9 +2,6 @@
 
 namespace Mindee\Parsing\Common\Ocr;
 
-use Mindee\Geometry\MinMaxUtils;
-use Mindee\Geometry\PolygonUtils;
-
 /**
  * OCR extraction for a single page.
  */
@@ -22,28 +19,28 @@ class OcrPage
     /**
      * Checks whether the words are on the same line.
      *
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $currentWord Reference word to compare.
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $nextWord    Next word to compare.
+     * @param OcrWord $currentWord Reference word to compare.
+     * @param OcrWord $nextWord    Next word to compare.
      * @return boolean
      */
     private static function areWordsOnSameLine(OcrWord $currentWord, OcrWord $nextWord): bool
     {
-        $currentInNext = PolygonUtils::isPointInPolygonY($currentWord->polygon->getCentroid(), $nextWord->polygon);
-        $nextInCurrent = PolygonUtils::isPointInPolygonY($nextWord->polygon->getCentroid(), $currentWord->polygon);
+        $currentInNext = $nextWord->polygon->isPointInY($currentWord->polygon->getCentroid());
+        $nextInCurrent = $currentWord->polygon->isPointInY($nextWord->polygon->getCentroid());
         return $currentInNext || $nextInCurrent;
     }
 
     /**
      * Compares word positions on the X axis. Returns a sort-compliant result (0;-1;1).
      *
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $word1 First word.
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $word2 Second word.
+     * @param OcrWord $word1 First word.
+     * @param OcrWord $word2 Second word.
      * @return integer
      */
     public static function getMinMaxX(OcrWord $word1, OcrWord $word2): int
     {
-        $word1X = MinMaxUtils::getMinMaxX($word1->polygon->getCoordinates())->getMin();
-        $word2X = MinMaxUtils::getMinMaxX($word2->polygon->getCoordinates())->getMin();
+        $word1X = $word1->polygon->getMinMaxX()->getMin();
+        $word2X = $word2->polygon->getMinMaxX()->getMin();
         if ($word1X == $word2X) {
             return 0;
         }
@@ -53,14 +50,14 @@ public static function getMinMaxX(OcrWord $word1, OcrWord $word2): int
     /**
      * Compares word positions on the Y axis. Returns a sort-compliant result (0;-1;1).
      *
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $word1 First word.
-     * @param \Mindee\Parsing\Common\Ocr\OcrWord $word2 Second word.
+     * @param OcrWord $word1 First word.
+     * @param OcrWord $word2 Second word.
      * @return integer
      */
     public static function getMinMaxY(OcrWord $word1, OcrWord $word2): int
     {
-        $word1Y = MinMaxUtils::getMinMaxY($word1->polygon->getCoordinates())->getMin();
-        $word2Y = MinMaxUtils::getMinMaxY($word2->polygon->getCoordinates())->getMin();
+        $word1Y = $word1->polygon->getMinMaxY()->getMin();
+        $word2Y = $word2->polygon->getMinMaxY()->getMin();
         if ($word1Y == $word2Y) {
             return 0;
         }

src/Parsing/Standard/FieldPositionMixin.php

@@ -12,11 +12,11 @@
 trait FieldPositionMixin
 {
     /**
-     * @var \Mindee\Geometry\Polygon A polygon containing the word in the document.
+     * @var Polygon A polygon containing the word in the document.
      */
     public Polygon $polygon;
     /**
-     * @var \Mindee\Geometry\Polygon|null A right rectangle containing the word in the document.
+     * @var Polygon|null A right rectangle containing the word in the document.
      */
     public ?Polygon $boundingBox;