IDE autocomplete support through PHPDoc added 🚀

Author: rahulhaque

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.2, 8.3]
+        php: [8.2]
         laravel: [11.*]
         stability: [prefer-stable]
         include:

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-filepond` will be documented in this file.
 
+## 11.2.4 - 2025-07-16
+
+- Added PHPDoc for IDE autocomplete support. 🚀
+
 ## 11.1.4 - 2025-05-08
 
 - Fixed overriding the disk default visibility #75. 🐛

README.md

@@ -32,6 +32,7 @@ See the corresponding branch for the documentation.
 
 |Version|Branch|
 |:-:|:-:|
+|Laravel 12|[12.x branch](../../tree/12.x/README.md)|
 |Laravel 11|[11.x branch](../../tree/11.x/README.md)|
 |Laravel 10|[10.x branch](../../tree/10.x/README.md)|
 |Laravel 9|[9.x branch](../../tree/9.x/README.md)|

src/Filepond.php

@@ -2,7 +2,6 @@
 
 namespace RahulHaque\Filepond;
 
-use Illuminate\Http\File;
 use Illuminate\Support\Facades\Storage;
 use RahulHaque\Filepond\Models\Filepond as FilepondModel;
 
@@ -27,7 +26,7 @@ public function field(string|array|null $field, bool $checkOwnership = true)
     /**
      * Return file object from the field
      *
-     * @return array|\Illuminate\Http\UploadedFile
+     * @return \Illuminate\Http\UploadedFile|array<int, \Illuminate\Http\UploadedFile>|null
      */
     public function getFile()
     {
@@ -48,7 +47,7 @@ public function getFile()
      * Get the filepond file as Data URL string
      * More at - https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
      *
-     * @return array|string
+     * @return array|array<int, string>|null
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
@@ -80,7 +79,25 @@ public function getModel()
     /**
      * Copy the FilePond files to destination
      *
-     * @return array
+     * @return array{
+     *     id: int,
+     *     dirname: string,
+     *     basename: string,
+     *     extension: string,
+     *     mimetype: string,
+     *     filename: string,
+     *     location: string,
+     *     url: string
+     * }|array<int, array{
+     *     id: int,
+     *     dirname: string,
+     *     basename: string,
+     *     extension: string,
+     *     mimetype: string,
+     *     filename: string,
+     *     location: string,
+     *     url: string
+     * }>|null
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
@@ -109,7 +126,25 @@ public function copyTo(string $path, string $disk = '', string $visibility = '')
     /**
      * Copy the FilePond files to destination and delete
      *
-     * @return array
+     * @return array{
+     *     id: int,
+     *     dirname: string,
+     *     basename: string,
+     *     extension: string,
+     *     mimetype: string,
+     *     filename: string,
+     *     location: string,
+     *     url: string
+     * }|array<int, array{
+     *     id: int,
+     *     dirname: string,
+     *     basename: string,
+     *     extension: string,
+     *     mimetype: string,
+     *     filename: string,
+     *     location: string,
+     *     url: string
+     * }>|null
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
@@ -146,7 +181,7 @@ public function moveTo(string $path, string $disk = '', string $visibility = '')
     public function delete()
     {
         if (! $this->getFieldValue()) {
-            return null;
+            return;
         }
 
         if ($this->getIsMultipleUpload()) {
@@ -175,7 +210,16 @@ public function delete()
     /**
      * Put the file in permanent storage and return response
      *
-     * @return array
+     * @return array{
+     *     id: int,
+     *     dirname: string,
+     *     basename: string,
+     *     extension: string,
+     *     mimetype: string,
+     *     filename: string,
+     *     location: string,
+     *     url: string
+     * }
      *
      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
@@ -188,7 +232,7 @@ private function putFile(FilepondModel $filepond, string $path, string $disk, st
         Storage::disk($permanentDisk)->writeStream(
             $pathInfo['dirname'].DIRECTORY_SEPARATOR.$pathInfo['filename'].'.'.$filepond->extension,
             Storage::disk($this->getTempDisk())->readStream($filepond->filepath),
-            $visibility !== '' ? ['visibility' => $visibility] : [],
+            $visibility !== '' ? ['visibility' => $visibility] : []
         );
 
         return [