config, optimize func

Author: SergeyMiracle

composer.json

@@ -18,5 +18,18 @@
         "psr-4": {
             "SergeyMiracle\\Uploadable\\": "src/"
         }
+    },
+    "extra": {
+      "laravel": {
+        "providers": [
+          "SergeyMiracle\\Uploadable\\UploadableServiceProvider"
+        ]
+      }
+    },
+    "suggest": {
+        "spatie/image-optimizer": "Easily optimize images using PHP"
+    },
+    "config": {
+        "sort-packages": true
     }
 }

config/uploadable.php

@@ -0,0 +1,10 @@
+<?php
+
+return [
+  'root' => '/upload/', // slashes in start and end of path required
+
+  'images' => [
+    'optimize' => false,  // optimize images using spatie/image-optimizer
+    'max_heigth' => 900  // auto resize image to a height when optimizing and constrain aspect ratio (auto width)
+  ]
+];

readme.md

@@ -15,7 +15,8 @@ class Post extends Model {
   protected $uploadables = ['featured_image'];
 
   protected $upload_dir = '.images';
-  
+
+  // optional
   protected $cropped = [
           'featured_image' => ['width' => 25, 'height' => 25]
       ];
@@ -38,22 +39,25 @@ Setup 'upload' disk in `config/filesystems.php`
 
         'upload' => [
             'driver' => 'local',
-            'root' => public_path('upload'),
+            'root' => public_path(config('uploadable.root')),
             'visibility' => 'public',
         ],
 
         ...
     ]
 ```
 
+
 On saving array of files, a json encoded string saved in database.
 
 Includes uploadable trait for controller - `UploadableControllerTrait`
 UploadableControllerTrait has two methods: `moveFile` and `moveImage`
-Both expects `UploadedFile` instance. moveImage methods crops image.
+Both expects `UploadedFile` instance. moveImage method crops image.
 
 ```
 $this->moveFile($request->file('image'))
 
 $this->moveImage($request->file('image'), $width, $height)
-```
+```
+
+If you want to use image optimization install `spatie/image-optimizer` and set optimization to true in config.

src/UploadableControllerTrait.php

@@ -7,6 +7,8 @@
 
 trait UploadableControllerTrait
 {
+    use UtilsTrait;
+
     /**
      * Save file on disk
      *
@@ -21,7 +23,13 @@ private function moveFile($file)
             throw new FileException($e->getMessage());
         }
 
-        return '/upload/' . $path;
+        $path = config('uploadable.root') . $path;
+
+        if (config('uploadable.images.optimize') && getimagesize(public_path($path))) {
+            $this->perfomOptimize(public_path($path));
+        }
+
+        return $path;
     }
 
     /**
@@ -40,26 +48,6 @@ private function moveImage($file, $width = 250, $height = 250)
         return $path;
     }
 
-    /**
-     * @return string
-     */
-    private function getUploadDir()
-    {
-        $date = new Carbon();
-        return $this->upload_dir . DIRECTORY_SEPARATOR . $date->year . DIRECTORY_SEPARATOR . $date->month;
-    }
-
-    /**
-     * @param $file string
-     * @return string
-     */
-    private function createFileName($file)
-    {
-        $path = pathinfo($file);
-
-        return uniqid() . '_' . str_slug($path['filename'], '_') . '.' . $path['extension'];
-    }
-
     /**
      * Remove file
      *

src/UploadableModelTrait.php

@@ -4,9 +4,12 @@
 
 use Carbon\Carbon;
 use Symfony\Component\HttpFoundation\File\Exception\FileException;
+use Spatie\ImageOptimizer\OptimizerChainFactory;
 
 trait UploadableModelTrait
 {
+    use UtilsTrait;
+
     /**
      * Boot the trait's observer.
      *
@@ -88,9 +91,16 @@ private function moveFile($file)
             throw new FileException($e->getMessage());
         }
 
-        return '/upload/' . $path;
+        $path = config('uploadable.root') . $path;
+
+        if (config('uploadable.images.optimize') && getimagesize(public_path($path))) {
+            $this->perfomOptimize(public_path($path));
+        }
+
+        return $path;
     }
 
+
     /**
      * Uploadable fields getter.
      *
@@ -124,16 +134,6 @@ private function checkForUploadables()
         }
     }
 
-    /**
-     * @param $file string
-     * @return string
-     */
-    private function createFileName($file)
-    {
-        $path = pathinfo($file);
-
-        return uniqid() . '_' . str_slug($path['filename'], '_') . '.' . $path['extension'];
-    }
 
     /**
      * Delete an existing 'uploadable' file in
@@ -169,14 +169,6 @@ private function deleteExisting($key)
         return false;
     }
 
-    /**
-     * @return string
-     */
-    public function getUploadDir()
-    {
-        $date = new Carbon();
-        return $this->upload_dir . DIRECTORY_SEPARATOR . $date->year . DIRECTORY_SEPARATOR . $date->month;
-    }
 
     /**
      * @param string $upload_dir

src/UploadableServiceProvider

@@ -0,0 +1,23 @@
+<?php
+
+namespace SergeyMiracle\Uploadable;
+
+use Illuminate\Support\ServiceProvider;
+
+class UploadableServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/uploadable.php' => config_path('uploadable.php'),
+            ], 'config');
+        }
+    }
+
+
+    public function register()
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/uploadable.php', 'uploadable');
+    }
+}

src/UtilsTrait.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace SergeyMiracle\Uploadable;
+
+trait UtilsTrait
+{
+    private function perfomOptimize($path)
+    {
+        [$width, $height] = getimagesize($path);
+
+        if ($height > config('uploadable.images.max_height')) {
+            \Image::make($path)->resize(null, config('uploadable.images.max_height'), function ($constraint) {
+                $constraint->aspectRatio();
+            })->save();
+        }
+
+        $optimizerChain = OptimizerChainFactory::create();
+        $optimizerChain->optimize($path);
+    }
+
+
+    /**
+     * @return string
+     */
+    public function getUploadDir()
+    {
+        $date = new Carbon();
+        return $this->upload_dir . DIRECTORY_SEPARATOR . $date->year . DIRECTORY_SEPARATOR . $date->month;
+    }
+
+
+    /**
+     * @param $file string
+     * @return string
+     */
+    private function createFileName($file)
+    {
+        $path = pathinfo($file);
+
+        return uniqid() . '_' . str_slug($path['filename'], '_') . '.' . $path['extension'];
+    }
+}