Update docs for 3.1

Author: patrickbrouwers

.vuepress/3.1.js

@@ -1,7 +1,7 @@
 module.exports = [
     {
         title: 'Getting Started',
-        collapsable: false,
+        collapsable: true,
         children: prefix('getting-started', [
             '',
             'license',
@@ -13,7 +13,7 @@ module.exports = [
     },
     {
         title: 'Exports',
-        collapsable: false,
+        collapsable: true,
         children: prefix('exports', [
             '',
             'collection',
@@ -33,7 +33,7 @@ module.exports = [
     },
     {
         title: 'Imports',
-        collapsable: false,
+        collapsable: true,
         children: prefix('imports', [
             '',
             'basics',

.vuepress/config.js

@@ -1,6 +1,6 @@
 module.exports = {
     title: 'Laravel Excel',
-    description: 'Supercharged Excel exports in Laravel',
+    description: 'Supercharged Excel exports and imports in Laravel',
     ga: 'UA-775649-7',
     serviceWorker: true,
 
@@ -12,7 +12,7 @@ module.exports = {
         [
             'link',
             {
-                href: 'https://fonts.googleapis.com/css?family=Source+Sans+Pro:100,300,400,500,600,700',
+                href: 'https://fonts.googleapis.com/css?family=Nunito:100,300,400,500,600,700',
                 rel: 'stylesheet',
                 type: 'text/css',
             },
@@ -31,7 +31,7 @@ module.exports = {
         algolia: {
             apiKey: 'e95794f59bac5401e3930f71feb3a8e2',
             indexName: 'laravel_excel',
-            algoliaOptions: { 'facetFilters': ["version:3.0"] },
+            algoliaOptions: { 'facetFilters': ["version:3.1"] },
         },
 
         serviceWorker: {
@@ -43,9 +43,9 @@ module.exports = {
                 text: 'Version',
                 link: '/',
                 items: [
+                    {text: '3.1', link: '/3.1/'},
                     {text: '3.0', link: '/3.0/'},
                     {text: '2.1', link: '/2.1/'},
-                    {text: '3.1 (Unreleased)', link: '/3.1/'},
                 ]
             },
             {

.vuepress/style.styl

@@ -1,6 +1,6 @@
 body
   background-color #f7fafc !important
-  font-family "Source Sans Pro", -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif !important
+  font-family "Nunito", -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif !important
 
 .home .hero img
   margin-bottom 0 !important
@@ -16,3 +16,9 @@ body
 .home .hero .action-button
   font-size : 1rem !important
   padding : 0.7rem 1.3rem !important
+
+.sidebar-heading
+  color: #2c3e50 !important
+
+.sidebar-heading.open, .sidebar-heading:hover
+  color: #4dc0b5 !important

3.1/exports/collection.md

@@ -36,7 +36,7 @@ public function storeExcel()
 }
 ```
 
-:bulb: More about storing exports can be found in the [storing exports on disk page](/3.0/exports/store.html).
+:bulb: More about storing exports can be found in the [storing exports on disk page](/3.1/exports/store.html).
 
 ### Dependency injection
 

3.1/getting-started/README.md

@@ -1,13 +1,16 @@
 # Introduction
 
 :rocket: Laravel Excel is intended at being Laravel-flavoured PhpSpreadsheet: a simple, but elegant wrapper around PhpSpreadsheet with the goal of simplifying
-exports. 
+exports and imports. 
 
 :fire: [PhpSpreadsheet](https://phpspreadsheet.readthedocs.io/) is a library written in pure PHP and providing a set of classes that allow you to read from and to write to different spreadsheet file formats, like Excel and LibreOffice Calc.
 
 Laravel Excel features:
 
-* Easily export collections to Excel
-* Export queries with automatic chunking for better performance
-* Queue exports for better performance
-* Easily export Blade views to Excel
+* Easily export collections to Excel.
+* Export queries with automatic chunking for better performance.
+* Queue exports for better performance.
+* Easily export Blade views to Excel.
+* Easily import to collections.
+* Read the Excel file in chunks.
+* Handle the import inserts in batches.

3.1/getting-started/contributing.md

@@ -8,7 +8,7 @@ Please read and understand the contribution guide before creating an issue or pu
 
 - [Docs](https://laravel-excel.maatwebsite.nl)
 - [Issue tracker](https://github.com/Maatwebsite/Laravel-Excel/issues)
-- [Support](/3.0/getting-started/support.html)
+- [Support](/3.1/getting-started/support.html)
 
 ## Etiquette
 
@@ -30,15 +30,15 @@ whether or not your feature is likely to be used by other users of the project.
 
 - Check the codebase to ensure that your feature doesn't already exist.
 - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
-- Use the [pull request template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.0/.github/PULL_REQUEST_TEMPLATE.md).
+- Use the [pull request template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.1/.github/PULL_REQUEST_TEMPLATE.md).
 
 ## How to report a bug?
 
 - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
 - Check to make sure your bug report isn't already present within the project.
 - Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
 - Check the pull requests tab to ensure that the feature isn't already in progress.
-- Use the [issue template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.0/.github/ISSUE_TEMPLATE.md).
+- Use the [issue template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.1/.github/ISSUE_TEMPLATE.md).
 
 ## Requirements
 

3.1/getting-started/installation.md

@@ -4,7 +4,7 @@
 
 * PHP: `^7.0`
 * Laravel: `^5.5`
-* PhpSpreadsheet: `^1.2`
+* PhpSpreadsheet: `^1.4`
 * PHP extension `php_zip` enabled
 * PHP extension `php_xml` enabled
 * PHP extension `php_gd2` enabled
@@ -51,14 +51,15 @@ This will create a new config file named `config/excel.php`.
 
 ## Usage
 
-Laravel Excel can be used in a various of ways. I'm sure you will find your prefered of using it. This can be either via dependency injection or if you prefer you can even use a facade.
+Laravel Excel can be used in a various of ways. I'm sure you will find your preferred of using it. This can be either via dependency injection or if you prefer you can even use a facade.
 
 ### Via dependency injection
 
 You can inject the `Excel` manager class into your class, either via constructor injection or method injection in case of a controller.
 
 ```php
-use App\YourExport;
+use App\Exports\YourExport;
+use App\Imports\YourImport;
 use Maatwebsite\Excel\Excel;
 
 class YourController
@@ -72,7 +73,12 @@ class YourController
 
     public function export()
     {
-        return $this->excel->download(new YourExport);
+        return $this->excel->download(new YourExport, 'users.xlsx');
+    }
+    
+    public function import()
+    {
+        return $this->excel->import(new YourImport, 'users.xlsx');
     }
 }
 ```
@@ -82,7 +88,7 @@ class YourController
 You can also use the `Maatwebsite\Excel\Exporter` to decouple more from the concrete Excel manager implementation.
 
 ```php
-use App\YourExport;
+use App\Exports\YourExport;
 use Maatwebsite\Excel\Exporter;
 
 class YourController
@@ -101,19 +107,48 @@ class YourController
 }
 ```
 
+### Via Importer interface
+
+You can also use the `Maatwebsite\Excel\Importer` to decouple more from the concrete Excel manager implementation.
+
+```php
+use App\Imports\YourImport;
+use Maatwebsite\Excel\Importer;
+
+class YourController
+{
+    private $importer;
+
+    public function __construct(Importer $importer)
+    {
+        $this->importer = $importer;
+    }
+    
+    public function import()
+    {
+        return $this->importer->import(new YourImport, 'users.xlsx');
+    }
+}
+```
+
 ### Via the Facade
 
 If you prefer facades, you can you use the `Maatwebsite\Excel\Facades\Excel` facade or if you use the alias the `Excel` facade alias.
 
 ```php
-use App\YourExport;
+use App\Exports\YourExport;
 use Maatwebsite\Excel\Facades\Excel;
 
 class YourController
 {
     public function export()
     {
-        return Excel::download(new YourExport);
+        return Excel::download(new YourExport, 'users.xlsx');
+    }
+    
+    public function import()
+    {
+        return Excel::import(new YourImport, 'users.xlsx');
     }
 }
 ```

3.1/getting-started/license.md

@@ -10,7 +10,7 @@ The Netherlands
 You are free to use the software as you like. The code can be forked and modified, but the original copyright author should always be included!
 
 ::: warning Support
-We hold no liability and will provide support on a best effort basis. For more information about support please see [support](https://laravel-excel.maatwebsite.nl/docs/3.0/getting-started/support).
+We hold no liability and will provide support on a best effort basis. For more information about support please see [support](https://laravel-excel.maatwebsite.nl/docs/3.1/getting-started/support).
 :::
 
 :rocket: If you use the software commercially and need support urgently, we can offer this on a commercial basis. Please contact <[email protected]> or phone +31 (0)10 744 9312. 

3.1/getting-started/support.md

@@ -13,14 +13,13 @@ Versions will be supported for a limited amount of time.
 | Version | Laravel Version | Php Version | Support |
 |---- |----|----|----|
 | 2.1 | <=5.6 | <=7.0 | Unsupported since 15-5-2018 |
-| 3.0 | ^5.5 |  ^7.0 | Security fixes till 01-04-2019 |
+| 3.0 | ^5.5 |  ^7.0 | Security fixes till 31-12-2018 |
 | 3.1 | ^5.5 |  ^7.0 | New features |
 
 ::: warning PHP version support
 Support for PHP versions will only be maintained for a period of six months beyond the end-of-life of that PHP version.
 :::
 
-
 ## Requesting support
 Before you request support, please check the following:
 * Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.

3.1/getting-started/upgrade.md

@@ -4,11 +4,14 @@
 
 ## Upgrading to 3.1 from 3.0
 
-Version 3.1 is backwards compatible with 3.0.
+Version 3.1 is backwards compatible with 3.0. Only features were added in this release.
 
 __Additions__
 
 * Imports feature.
+* ChunkReading
+* BatchInserts
+* Queued imports
 * ToArray concern for Exports.
 * Custom value binders for Imports and Exports.
 
@@ -31,3 +34,5 @@ ALL Laravel Excel 2.* methods are deprecated and will not be able to use in 3.0
 - Excel::load() is removed and replaced by Excel::import($yourImport)
 - Excel::create() is removed and replaced by Excel::download/Excel::store($yourExport)
 - 3.0 provides no convenience methods for styling, you are encouraged to use PhpSpreadsheets native methods.
+
+You can find an example upgrade for an export here: https://github.com/Maatwebsite/Laravel-Excel/issues/1799

README.md

@@ -2,35 +2,37 @@
 home: true
 heroImage: /assets/img/logo-small.png
 actionText: Read documentation →
-actionLink: /3.0/
+actionLink: /3.1/
 features:
-- title: 💪 Export collections to Excel.
-  details: Supercharge your Laravel collections and export them directly to an Excel or CSV document. Exporting has never been so easy.
+- title: 💪 Export to Excel.
+  details: Supercharge your Laravel collections or Blade views and export them directly to an Excel or CSV document. Exporting has never been so easy.
 - title: 🚀 Supercharged exports. 
   details: Export queries with automatic chunking for better performance. For even more superpowers, exports can also be queued.
-- title: 🔥 Export Blade views.
-  details: Want to have a custom layout in your spreadsheet? Use a HTML table in a Blade view and export that to Excel.
+- title: 🔥 Supercharged imports. 
+  details: Import workbooks and worksheets to Eloquent models with chunk reading and batch inserts! You can also queue every chunk of a file! Your entire import will happen in the background.
 footer: MIT Licensed | Powered by Maatwebsite
 ---
 
-:bulb: Install the package via `composer`
+:bulb: Install the package via `composer`.
 
 ```
 composer require maatwebsite/excel
 ```
 
-:muscle: Create an export class
+:muscle: Create an export and import class.
 
 ```php
 php artisan make:export UsersExport --model=App\\User
+php artisan make:import UsersImport --model=App\\User
 ```
 
-:fire: Download your export
+:fire: Download your export and import your file.
 
 ```php
 <?php 
 
-use App\UsersExport;
+use App\Exports\UsersExport;
+use App\Imports\UsersImport;
 use Maatwebsite\Excel\Facades\Excel;
 use App\Http\Controllers\Controller;
 
@@ -40,5 +42,10 @@ class UsersController extends Controller
     {
         return Excel::download(new UsersExport, 'users.xlsx');
     }
+    
+    public function import() 
+    {
+        return Excel::import(new UsersImport, 'users.xlsx');
+    }
 }
 ```

package.json

@@ -1,6 +1,6 @@
 {
     "dependencies": {
-        "vuepress": "vuejs/vuepress#5084fcab63c0381ef5170a55f76e38f306dc756b"
+        "vuepress": "^0.14"
     },
     "scripts": {
         "docs:build": "vuepress build",

yarn.lock

@@ -5628,7 +5628,7 @@ regexpu-core@^4.1.3, regexpu-core@^4.1.4:
     unicode-match-property-ecmascript "^1.0.4"
     unicode-match-property-value-ecmascript "^1.0.2"
 
-register-service-worker@^1.4.1:
+register-service-worker@^1.5.1:
   version "1.5.2"
   resolved "https://registry.yarnpkg.com/register-service-worker/-/register-service-worker-1.5.2.tgz#a4631896c38d6ec5597358f44988cc46a911912d"
   integrity sha512-XNqSZHJsFGnvEGkg/2IrCp6G8Ya3qLj4mq0bSHil/dfdO82LOxGnMnJjAD9MYCvf/8cDCO8pL+1i65yzmP7rPQ==
@@ -6779,9 +6779,10 @@ vuepress-html-webpack-plugin@^3.2.0:
     toposort "^1.0.0"
     util.promisify "1.0.0"
 
-vuepress@vuejs/vuepress#5084fcab63c0381ef5170a55f76e38f306dc756b:
-  version "0.13.0"
-  resolved "https://codeload.github.com/vuejs/vuepress/tar.gz/5084fcab63c0381ef5170a55f76e38f306dc756b"
+vuepress@^0.14:
+  version "0.14.4"
+  resolved "https://registry.yarnpkg.com/vuepress/-/vuepress-0.14.4.tgz#fea77daa840b11429564bdddde3653bbbec4affb"
+  integrity sha512-AUZ+6wL1uXapX+I7h4EeXQ2Gcxaars7Ys5K8EUVuCgyDB0v36eoQWnoAVpNpMXL7kPCkVSq8DUtJQtOtHluSXQ==
   dependencies:
     "@babel/core" "7.0.0-beta.47"
     "@vue/babel-preset-app" "3.0.0-beta.11"
@@ -6821,7 +6822,7 @@ vuepress@vuejs/vuepress#5084fcab63c0381ef5170a55f76e38f306dc756b:
     portfinder "^1.0.13"
     postcss-loader "^2.1.5"
     prismjs "^1.13.0"
-    register-service-worker "^1.4.1"
+    register-service-worker "^1.5.1"
     semver "^5.5.0"
     stylus "^0.54.5"
     stylus-loader "^3.0.2"