LaravelからSFTP転送でのファイル操作を行う（league/flysystem-sftp）

サービスプロパイダ生成

artisanコマンドでサービスプロパイダクラスを生成します。Laravelルートディレクトリへ移動し、以下のコマンドを叩きます。

# Laravelルートディレクトリへ移動
cd /path/to/laravel

# サービスプロパイダファイルを生成する
php artisan make:provider SftpServiceProvider

# 実行結果
[demo@localhost laravel]# php artisan make:provider SftpServiceProvider
Provider created successfully.

laravel/app/Providers 配下に SftpServiceProvider.php が生成されます。

laravel
├─ app
│   ├─ Providers
│   │   ├─ SftpServiceProvider.php

laravel/app/Providers/SftpServiceProvider.php

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class SftpServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

SFTPサービスプロパイダ実装

それでは生成したSFTPサービスプロパイダクラスを実装していきます。以下のようになります。

laravel/app/Providers/SftpServiceProvider.php

<?php

namespace App\Providers;

use Storage;
use League\Flysystem\Filesystem;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Sftp\SftpAdapter;

class SftpServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap services.
     *
     * @return void
     */
    public function boot()
    {
      Storage::extend('sftp', function ($app, $config) {
        return new Filesystem(new SftpAdapter([
          'host'        => $config['host'],
          'port'        => $config['port'],
          'username'    => $config['username'],
          'password'    => $config['password'],
          'privateKey'  => $config['privateKey'],
          'root'        => $config['root'],
          'timeout'     => $config['timeout'],
        ]));
      });
    }

    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

Storageファサードのextend()メソッドで、第一引数には登録する種別sftpを渡しつつ、第二引数でクロージャを定義しています。

各設定変数をSftpAdapterインスタンス化の際に渡し、それらをFilesystemのインスタンスに渡します。

これで、FilesystemでSFTPが使えるようになりました。

コントローラ作成

コントローラにStorageファサードを使ってファイル操作を記述します。

laravel/app/Http/Controllers/SampleController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class SampleController extends Controller
{
  public function index()
  {
    $contents = file_get_contents(storage_path('test.txt'));
    Storage::disk('sftp')->put('file.txt', $contents);
  }
}

アプリケーション側のStorage/app配下にあるtest.txtを読み込み、SFTPにて接続先の/tmpディレクトリへfile.txtとして保存します。

ちなみにコントローラには記述がありませんが、.envに初期ディレクトリを/tmpと記述したので、接続先の初期ディレクトリは/tmpとなり、put()メソッドでファイル名だけを記述した場合の保存先パスは/tmp/file.txtとなります。

ルーティング

最後にルーティングを記述します。

laravel/routes/web.php

Route::get('/sample/sftp', 'SampleController@index');