Add docblock on BackupsController class

app/Http/Controllers/BackupsController.php

@@ -2,16 +2,26 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Controllers\Controller;
-use App\Http\Requests\BackupUploadRequest;
-use BackupManager\Filesystems\Destination;
 use BackupManager\Manager;
 use Illuminate\Http\Request;
 use League\Flysystem\FileExistsException;
+use App\Http\Requests\BackupUploadRequest;
+use BackupManager\Filesystems\Destination;
 use League\Flysystem\FileNotFoundException;
 
+/**
+ * Database Backups Controller.
+ *
+ * @author Nafies Luthfi <nafiesL@gmail.com>
+ */
 class BackupsController extends Controller
 {
+    /**
+     * List of backup files.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\View\View
+     */
     public function index(Request $request)
     {
         if (!file_exists(storage_path('app/backup/db'))) {
@@ -28,10 +38,16 @@ class BackupsController extends Controller
         return view('backups.index', compact('backups'));
     }
 
+    /**
+     * Create new backup file.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Routing\Redirector
+     */
     public function store(Request $request)
     {
         $this->validate($request, [
-            'file_name' => 'nullable|max:30|regex:/^[\w._-]+$/'
+            'file_name' => 'nullable|max:30|regex:/^[\w._-]+$/',
         ]);
 
         try {
@@ -39,7 +55,7 @@ class BackupsController extends Controller
             $fileName = $request->get('file_name') ?: date('Y-m-d_Hi');
 
             $manager->makeBackup()->run('mysql', [
-                    new Destination('local', 'backup/db/' . $fileName)
+                new Destination('local', 'backup/db/'.$fileName),
             ], 'gzip');
 
             return redirect()->route('backups.index');
@@ -48,29 +64,55 @@ class BackupsController extends Controller
         }
     }
 
+    /**
+     * Delete a backup file from storage.
+     *
+     * @param  string  $fileName
+     * @return \Illuminate\Routing\Redirector
+     */
     public function destroy($fileName)
     {
         if (file_exists(storage_path('app/backup/db/').$fileName)) {
             unlink(storage_path('app/backup/db/').$fileName);
         }
+
         return redirect()->route('backups.index');
     }
 
+    /**
+     * Download a backup file.
+     *
+     * @param  string  $fileName
+     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
+     */
     public function download($fileName)
     {
         return response()->download(storage_path('app/backup/db/').$fileName);
     }
 
+    /**
+     * Restore database from a backup file.
+     *
+     * @param  string  $fileName
+     * @return \Illuminate\Routing\Redirector
+     */
     public function restore($fileName)
     {
         try {
             $manager = app()->make(Manager::class);
             $manager->makeRestore()->run('local', 'backup/db/'.$fileName, 'mysql', 'gzip');
-        } catch (FileNotFoundException $e) {}
+        } catch (FileNotFoundException $e) {
+        }
 
         return redirect()->route('backups.index');
     }
 
+    /**
+     * Upload a backup file to the storage.
+     *
+     * @param  \App\Http\Requests\BackupUploadRequest  $request
+     * @return \Illuminate\Routing\Redirector
+     */
     public function upload(BackupUploadRequest $request)
     {
         $file = $request->file('backup_file');
@@ -81,5 +123,4 @@ class BackupsController extends Controller
 
         return redirect()->route('backups.index');
     }
-
 }