Add importing basics

Author: patrickbrouwers

.vuepress/3.1.js

@@ -36,6 +36,7 @@ module.exports = [
         collapsable: false,
         children: prefix('imports', [
             '',
+            'basics',
             'collection',
             'model',
             'importables',

3.1/imports/README.md

@@ -16,6 +16,7 @@ If you prefer to create the import manually, you can create the following in `Ap
 namespace App\Imports;
 
 use App\User;
+use Illuminate\Support\Facades\Hash;
 use Maatwebsite\Excel\Concerns\ToModel;
 
 class UsersImport implements ToModel
@@ -28,8 +29,9 @@ class UsersImport implements ToModel
     public function model(array $row)
     {
         return new User([
-           'name'  => $row[0],
-           'email' => $row[1], 
+           'name'     => $row[0],
+           'email'    => $row[1], 
+           'password' => Hash::make($row[2]),
         ]);
     }
 }
@@ -49,7 +51,7 @@ class UsersController extends Controller
     {
         Excel::import(new UsersImport, 'users.xlsx');
 
-        return 'All good!';
+        return back()->with('success', ''All good!');
     }
 }
 ```

3.1/imports/basics.md

@@ -0,0 +1,73 @@
+## Importing basics
+
+If you have followed the 5 Minute Quickstart, you'll already have a `UsersImport` class.
+
+```php
+<?php
+
+namespace App\Imports;
+
+use App\User;
+use Illuminate\Support\Facades\Hash;
+use Maatwebsite\Excel\Concerns\ToModel;
+
+class UsersImport implements ToModel
+{
+    /**
+     * @param array $row
+     *
+     * @return User|null
+     */
+    public function model(array $row)
+    {
+        return new User([
+           'name'     => $row[0],
+           'email'    => $row[1],
+           'password' => Hash::make($row[2]),
+        ]);
+    }
+}
+```
+
+### Importing from default disk
+
+Passing the UsersImport object to the Excel::import() method, will tell the package how to import the file that is passed as second parameter. 
+The file is expected to be located in your default filesystem disk (see config/filesystems.php).
+
+```php
+Excel::import(new UsersImport, 'users.xlsx');
+```
+
+### Importing from anther disk
+
+You can specify another disk with the third parameter like your Amazon s3 disk. (see config/filesystems.php)
+
+```php
+Excel::import(new UsersImport, 'users.xlsx', 's3');
+```
+
+### Importing uploaded files
+
+If you let your user upload the document, you can also just pass the uploaded file directly.
+
+```php
+Excel::import(new UsersImport, request()->file('your_file'));
+```
+
+### Importing to array or collection
+
+If you want to bypass the `ToArray` or `ToCollection` concerns and want to have an array of imported data in your controller (beware of performance!), you can use the `::toArray()` or `::toCollection()` method.
+
+```php
+$array = Excel::toArray(new UsersImport, 'users.xlsx');
+
+$collection = Excel::toCollection(new UsersImport, 'users.xlsx');
+```
+
+### Specifying a reader type
+
+If the reader type is not detectable by the file extension, you can specify a reader type by passing it as fourth parameter.
+
+```php
+Excel::import(new UsersImport, 'users.xlsx', 's3', \Maatwebsite\Excel\Excel::XLSX);
+```

3.1/imports/importables.md

@@ -27,11 +27,19 @@ class UsersImport implements ToModel
 We can now import without the need for the facade:
 
 ```php
-return (new UsersImport)->import('users.xlsx');
+(new UsersImport)->import('users.xlsx', 'local', \Maatwebsite\Excel\Excel::XLSX);
 ```
 
 Or queue the import:
 
 ```php
-return (new UsersImport)->queue('users.xlsx');
+(new UsersImport)->queue('users.xlsx');
 ```
+
+The import can be loaded into an array or collection:
+
+```php
+$array = (new UsersImport)->toArray('users.xlsx');
+
+$collection = (new UsersImport)->toCollection('users.xlsx');
+```