Merge branch 'release/1.0.3'

Author: jnovermars

README.md

@@ -44,8 +44,8 @@ You need to request a new clientId and clientSecret for a new application on Azu
 
 
 ``` php
-use GWSN\Sharepoint\FlysystemSharepointAdapter;
-use GWSN\Sharepoint\SharepointConnector;
+use GWSN\FlysystemSharepoint\FlysystemSharepointAdapter;
+use GWSN\FlysystemSharepoint\SharepointConnector;
 use League\Flysystem\Filesystem;
 
 $tenantId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
@@ -72,6 +72,158 @@ $ composer run-script test
 
 If you discover any security related issues, please email [email protected] instead of using the issue tracker.
 
+
+## Laravel
+
+To use the flysystem in Laravel there are additional steps required:
+
+First we need to create a `FlySystemSharepointProvider` and register this in the `config/app.php`
+
+Then we need to create the config into the `config/filesystem.php`
+
+### Create the FlySystemSharepointProvider
+
+we need to create a provider to register the custom FlySystem Adapter
+
+create a new file in the `app/Providers` directory called `FlySystemSharepointProvider.php` with the following content:
+```PHP
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Filesystem\FilesystemAdapter;
+use Illuminate\Support\Facades\Storage;
+use Illuminate\Support\ServiceProvider;
+use League\Flysystem\Filesystem;
+use GWSN\FlysystemSharepoint\FlysystemSharepointAdapter;
+use GWSN\FlysystemSharepoint\SharepointConnector;
+
+class FlySystemSharepointProvider extends ServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register() { }
+
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        Storage::extend('sharepoint', function ($app, $config) {
+
+            $adapter = new FlysystemSharepointAdapter(new SharepointConnector(
+                    $config['tenantId'],
+                    $config['clientId'],
+                    $config['clientSecret'],
+                    $config['sharepointSite'],
+                ),
+                $config['prefix'],
+            );
+
+            return new FilesystemAdapter(
+                new Filesystem($adapter, $config),
+                $adapter,
+                $config
+            );
+        });
+    }
+}
+```
+
+### Register the provider in the App config
+Add the bottom of the list with providers we need to add the previous created Provider:
+
+```php 
+ 'providers' => [
+
+        /*
+         * Laravel Framework Service Providers...
+         */
+         [...]
+         App\Providers\FlySystemSharepointProvider::class,
+ ]
+```
+
+### Update the Filesystem config
+
+Add filesystem Disks section we will add a new custom disk: sharepoint.
+
+We use env variables as config but you could also enter them directly as string
+
+```php 
+ /*
+    |--------------------------------------------------------------------------
+    | Filesystem Disks
+    |--------------------------------------------------------------------------
+    |
+    | Here you may configure as many filesystem "disks" as you wish, and you
+    | may even configure multiple disks of the same driver. Defaults have
+    | been set up for each driver as an example of the required values.
+    |
+    | Supported Drivers: "local", "ftp", "sftp", "s3"
+    |
+    */
+
+    'disks' => [
+
+        'local' => [
+            'driver' => 'local',
+            'root' => storage_path('app'),
+            'throw' => false,
+        ],
+
+        'sharepoint' => [
+            'driver' => 'sharepoint',
+            'tenantId' => env('SHAREPOINT_TENANT_ID', 'secret'),
+            'clientId' => env('SHAREPOINT_CLIENT_ID', 'secret'),
+            'clientSecret' => env('SHAREPOINT_CLIENT_SECRET_VALUE', 'secret'),
+            'sharepointSite' => env('SHAREPOINT_SITE', 'laravelTest'),
+            'prefix' => env('SHAREPOINT_PREFIX', 'test'),
+        ]
+
+    ],
+```
+
+### Usage in laravel 
+it is bad practice to use logic into a controller but for example purpose we show it in the controller:
+
+`App\Http\Controllers\Controller.php`
+```php
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Support\Facades\Storage;
+
+class Controller extends BaseController
+{
+    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+
+    public function index() {
+
+        try {
+            Storage::disk('sharepoint')->put('test.txt', 'testContent');
+            return Storage::disk('sharepoint')->get('test.txt');
+            
+        } catch (\Exception $exception) {
+            dd($exception);
+        }
+        return 'error';
+    }
+}
+```
+
+
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.