feat: adds file type checking

Author: JasonTheAdams

src/Files/Contracts/FileInterface.php

@@ -17,10 +17,54 @@
 interface FileInterface
 {
     /**
-     * Gets the MIME type of the file.
+     * Gets the MIME type of the file as a string.
      *
      * @since n.e.x.t
-     * @return MimeType The MIME type (e.g., 'image/png', 'audio/mp3').
+     * @return string The MIME type string (e.g., 'image/png', 'audio/mp3').
      */
-    public function getMimeType(): MimeType;
+    public function getMimeType(): string;
+
+    /**
+     * Gets the MIME type object.
+     *
+     * @since n.e.x.t
+     * @return MimeType The MIME type object.
+     */
+    public function getMimeTypeObject(): MimeType;
+
+    /**
+     * Checks if the file is a video.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is a video.
+     */
+    public function isVideo(): bool;
+
+    /**
+     * Checks if the file is an image.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is an image.
+     */
+    public function isImage(): bool;
+
+    /**
+     * Checks if the file is audio.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is audio.
+     */
+    public function isAudio(): bool;
+
+    /**
+     * Checks if the file is text.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is text.
+     */
+    public function isText(): bool;
 }

src/Files/Traits/HasMimeType.php

@@ -12,7 +12,7 @@
  * This trait can be used by any class that needs to store and retrieve
  * a MIME type property.
  *
- * @since 1.0.0
+ * @since n.e.x.t
  */
 trait HasMimeType
 {
@@ -24,23 +24,83 @@ trait HasMimeType
     protected MimeType $mimeType;
 
     /**
-     * Gets the MIME type of the file.
+     * Gets the MIME type of the file as a string.
      *
-     * @return MimeType The MIME type.
+     * @since n.e.x.t
+     *
+     * @return string The MIME type string value.
+     */
+    public function getMimeType(): string
+    {
+        return (string) $this->mimeType;
+    }
+
+    /**
+     * Gets the MIME type object.
+     *
+     * @since n.e.x.t
      *
-     * @since 1.0.0
+     * @return MimeType The MIME type object.
      */
-    public function getMimeType(): MimeType
+    public function getMimeTypeObject(): MimeType
     {
         return $this->mimeType;
     }
 
     /**
-     * Gets the JSON schema for the MIME type property.
+     * Checks if the file is a video.
      *
-     * @return array{type: string, description: string, pattern: string} The JSON schema for the mimeType property.
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is a video.
+     */
+    public function isVideo(): bool
+    {
+        return $this->mimeType->isVideo();
+    }
+
+    /**
+     * Checks if the file is an image.
      *
      * @since n.e.x.t
+     *
+     * @return bool True if the file is an image.
+     */
+    public function isImage(): bool
+    {
+        return $this->mimeType->isImage();
+    }
+
+    /**
+     * Checks if the file is audio.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is audio.
+     */
+    public function isAudio(): bool
+    {
+        return $this->mimeType->isAudio();
+    }
+
+    /**
+     * Checks if the file is text.
+     *
+     * @since n.e.x.t
+     *
+     * @return bool True if the file is text.
+     */
+    public function isText(): bool
+    {
+        return $this->mimeType->isText();
+    }
+
+    /**
+     * Gets the JSON schema for the MIME type property.
+     *
+     * @since n.e.x.t
+     *
+     * @return array{type: string, description: string, pattern: string} The JSON schema for the mimeType property.
      */
     protected static function getMimeTypePropertySchema(): array
     {

src/Results/DTO/GenerativeAiResult.php

@@ -187,7 +187,7 @@ public function toImageFile(): FileInterface
     {
         $file = $this->toFile();
 
-        if (!$file->getMimeType()->isImage()) {
+        if (!$file->isImage()) {
             throw new \RuntimeException(
                 sprintf('File is not an image. MIME type: %s', $file->getMimeType())
             );
@@ -208,7 +208,7 @@ public function toAudioFile(): FileInterface
     {
         $file = $this->toFile();
 
-        if (!$file->getMimeType()->isAudio()) {
+        if (!$file->isAudio()) {
             throw new \RuntimeException(
                 sprintf('File is not an audio file. MIME type: %s', $file->getMimeType())
             );
@@ -229,7 +229,7 @@ public function toVideoFile(): FileInterface
     {
         $file = $this->toFile();
 
-        if (!$file->getMimeType()->isVideo()) {
+        if (!$file->isVideo()) {
             throw new \RuntimeException(
                 sprintf('File is not a video file. MIME type: %s', $file->getMimeType())
             );
@@ -313,7 +313,7 @@ public function toImageFiles(): array
     {
         return array_filter(
             $this->toFiles(),
-            fn(FileInterface $file) => $file->getMimeType()->isImage()
+            fn(FileInterface $file) => $file->isImage()
         );
     }
 
@@ -328,7 +328,7 @@ public function toAudioFiles(): array
     {
         return array_filter(
             $this->toFiles(),
-            fn(FileInterface $file) => $file->getMimeType()->isAudio()
+            fn(FileInterface $file) => $file->isAudio()
         );
     }
 
@@ -343,7 +343,7 @@ public function toVideoFiles(): array
     {
         return array_filter(
             $this->toFiles(),
-            fn(FileInterface $file) => $file->getMimeType()->isVideo()
+            fn(FileInterface $file) => $file->isVideo()
         );
     }