add crop mode toggle, update readme

Author: streamtw

readme.md

@@ -4,21 +4,21 @@
 
 Laravel File API is good way to handle files with Laravel Storage.
 
-### Install File API
+### Installation
 
-composer.json:
+    1. Install File API
 
-    "require" : {
-        "unisharp/laravel-fileapi" : "dev-master"
-    }, 
-    "repositories": {
-        "type": "git",
-        "url": "https://github.com/UniSharp/laravel-fileapi.git
-    }
+        composer require unisharp/laravel-fileapi
 
-save it and then 
+    1. Set service provider in `config/app.php`
 
-    composer update    
+        Unisharp\FileApi\FileApiServiceProvider::class,
+
+    1. publish config file
+
+        php artisan vendor:publish --tag=fileapi_config
+
+    1. fill the path in config/fileapi.php, it will generate routes for your files.
 
 ### Initialize File API
 
@@ -31,44 +31,21 @@ or
     $fa = new FileApi('/images'); # initialize it by giving a base path
 
 
-### Save to Storage By Giving Lravel Upload File
+### Save to Storage By Giving Uploaded File
 
-* Normal Usage
-
-    get unique filename
+* Default Usage : get unique filename
 
         $file = $fa->save(\Input::file('image')); // => wfj412.jpg
 
-    or input files is an array
-    
-        $files = [];
-        foreach (\Input::file('images') as $file) {
-            $files []= $fa->save('images');
-        }
-    
 * Custimize your upload file name
 
-        $file = $fa->save('image', 'custimized_filename'); // => custimized_filename.jpg
+        $file = $fa->save(\Input::file('image'), 'custimized_filename'); // => custimized_filename.jpg
           
 
 ### Get file fullpath (abstract path from Laravel Storage)
 
     $fa->getPath('wfj412.jpg'); // => '/images/wfj412.jpg'
 
-### Routing your files
-
-All uploaded files cannot found in public folder, because FileApi use Laravel Storage to store them.  
-You can write a routing rules to get it. it will response file content and use http cache by default.
-
-    Route::get('/upload/{filename}', function ($filename) {
-        $fa = new FileApi();
-        return $fa->getResponse($filename);
-    });
-    
-and it can add headers array by optional
-
-    return $fa->getResponse($filename, ['Content-Disposition', 'attachement']);
-    
 ### Parse File Path to URL
 if you store your file into cloud storage and you want to get url cloud site,
 you can use url() method to get it

src/FileApi.php

@@ -8,7 +8,9 @@
 class FileApi
 {
     protected $basepath;
-    protected $thumb_sizes = ['S' => '96x96', 'M' => '256x256', 'L' => '480x480'];
+    protected $default_sizes = ['S' => '96x96', 'M' => '256x256', 'L' => '480x480'];
+    protected $thumb_sizes = null;
+    protected $shouldCropThumb = false;
 
     public function __construct($basepath = '/')
     {
@@ -46,6 +48,13 @@ public function thumbs($thumb_sizes = array())
         return $this;
     }
 
+    public function crop()
+    {
+        $this->shouldCropThumb = true;
+
+        return $this;
+    }
+
     public function save(UploadedFile $upload_file, $cus_name = null)
     {
         $file = $this->moveFile($upload_file, $cus_name);
@@ -151,7 +160,7 @@ private function moveFile($upload_file, $cus_name)
 
         \File::delete($upload_file->getRealPath());
 
-        if (!is_null($img) && !empty($this->thumb_sizes)) {
+        if (!is_null($img) && !empty($this->getThumbSizes())) {
             $this->saveThumb($img, $original_name, $suffix);
         }
 
@@ -200,9 +209,9 @@ private function setTmpImage($upload_file)
 
     private function saveThumb($img, $original_name, $suffix)
     {
-        foreach ($this->thumb_sizes as $size_code => $size) {
-            if (is_int($size_code) && $size_code < count($this->thumb_sizes)) {
-                $size_name = $size;
+        foreach ($this->getThumbSizes() as $size_code => $size) {
+            if (is_int($size_code) && $size_code < count($this->getThumbSizes())) {
+                $size_name = 'L';
             } else {
                 $size_name = $size_code;
             }
@@ -211,7 +220,7 @@ private function saveThumb($img, $original_name, $suffix)
             $main_image   = $original_name . '.' . $suffix;
             $tmp_filename = 'tmp/' . $main_image;
 
-            $tmp_thumb = $this->resizeThumb($img, $size);
+            $tmp_thumb = $this->resizeOrCropThumb($img, $size);
 
             // save tmp image
             \Storage::disk('local')->put($tmp_filename, \Storage::get($this->basepath . $main_image));
@@ -227,25 +236,34 @@ private function saveThumb($img, $original_name, $suffix)
         }
     }
 
-    private function resizeThumb($img, $size)
+    private function resizeOrCropThumb($img, $size)
     {
         $width        = imagesx($img);
         $height       = imagesy($img);
         $arr_size     = explode('x', $size);
         $thumb_width  = (int)$arr_size[0];
         $thumb_height = (int)$arr_size[1];
 
+        if ($this->thumbShouldCrop()) {
+            $img = $this->cropThumb($img, $width, $height, $thumb_width, $thumb_height);
+        } else {
+            $this->resizeThumb($width, $height, $thumb_width, $thumb_height);
+        }
+
         // create a new temporary thumbnail image
         $tmp_thumb = imagecreatetruecolor($thumb_width, $thumb_height);
 
-        $img = $this->cropThumb($img, $width, $height, $thumb_width, $thumb_height);
-
         // copy and resize original image into thumbnail image
         imagecopyresized($tmp_thumb, $img, 0, 0, 0, 0, $thumb_width, $thumb_height, $width, $height);
 
         return $tmp_thumb;
     }
 
+    private function thumbShouldCrop()
+    {
+        return $this->shouldCropThumb;
+    }
+
     private function cropThumb($img, &$width, &$height, $thumb_width, $thumb_height)
     {
         $image_ratio = $height/$width;
@@ -281,4 +299,31 @@ private function cropThumb($img, &$width, &$height, $thumb_width, $thumb_height)
 
         return $img;
     }
+
+    private function resizeThumb($width, $height, &$thumb_width, &$thumb_height)
+    {
+        $image_ratio = $height/$width;
+        $thumb_ratio = $thumb_height/$thumb_width;
+
+        if ($image_ratio !== $thumb_ratio) {
+            if ($image_ratio < $thumb_ratio) {
+                $thumb_height = $thumb_width*$height/$width;
+            } else if ($image_ratio > $thumb_ratio) {
+                $thumb_width = $thumb_height*$width/$height;
+            }
+        }
+    }
+
+    private function getThumbSizes()
+    {
+        $config = config('fileapi.default_thumbs');
+
+        if (!is_null($this->thumb_sizes)) {
+            return $this->thumb_sizes;
+        } else if (!is_null($config)) {
+            return $config;
+        } else {
+            return $this->default_sizes;
+        }
+    }
 }

src/config/fileapi.php

@@ -15,4 +15,6 @@
 
     'path' => ['/images/event/'],
 
+    'default_thumbs' => ['S' => '96x96', 'M' => '256x256', 'L' => '480x480'],
+
 ];