イントロダクション

LaravelはFrank de Jongeさんが作成した、ありがたいほど素晴らしい抽象ファイルシステムであるFlysystem PHPパッケージを提供しています。LaravelとFlysystemの統合によりローカルのファイルシステム、Amazon S3、Rackspaceクラウドストレージを操作できる、シンプルなドライバーが提供できました。更に素晴らしいことにそれぞれのシステムに対し同じAPIを使用しているため、ストレージをとても簡単に変更できるのです。

設定

ファイルシステムの設定ファイルは、config/filesystems.phpです。このファイルの中に全「ディスク」の設定があります。それぞれのディスクは特定のストレージドライバーと保存場所を表します。設定ファイルにはサポート済みのドライバーそれぞれの設定例を用意しています。ですからストレージの設定と認証情報を反映するように、設定オプションを簡単に修正できます。

もちろん好きなだけディスクを設定できますし、同じドライバーに対し複数のディスクを持つことも可能です。

ローカルドライバー

localドライバーを使う場合、設定ファイルで指定したrootディレクトリーからの相対位置で全ファイル操作が行われることに注意してください。デフォルトでこの値はstorage/appディレクトリーに設定されています。そのため次のメソッドでファイルはstorage/app/file.txtとして保存されます。

Storage::disk('local')->put('file.txt', 'Contents');

他のドライバー使用要件

S3とRackspaceドライバーを使用する場合は、それに適合するパッケージをComposerでインストールする必要があります。

  • Amazon S3: league/flysystem-aws-s3-v3 ~1.0
  • Rackspace: league/flysystem-rackspace ~1.0

基本的な使用法

ディスクインスタンス取得

Storageファサードを使い設定済みのディスクへの操作ができます。たとえばこのファサードのputメソッドを使用し、デフォルトディスクにアバターを保存できます。Storageファサードのメソッド呼び出しで最初にdiskメソッドを呼び出さない場合、そのメソッドの呼び出しは自動的にデフォルトディスクに対し実行されます。

<?php

namespace App\Http\Controllers;

use Storage;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * 指定したユーザーのアバターを更新
     *
     * @param  Request  $request
     * @param  int  $id
     * @return Response
     */
    public function updateAvatar(Request $request, $id)
    {
        $user = User::findOrFail($id);

        Storage::put(
            'avatars/'.$user->id,
            file_get_contents($request->file('avatar')->getRealPath())
        );
    }
}

複数ディスクを使用する場合、Storageファサードに対しdiskメソッドを使用し特定のディスクへアクセスできます。もちろんdiskに続けメソッドをチェーンして実行できます。

$disk = Storage::disk('s3');

$contents = Storage::disk('local')->get('file.jpg')

ファイル取得

getメソッドは指定したファイルの内容を取得するために使用します。メソッドはファイルの内容をそのまま返します。

$contents = Storage::get('file.jpg');

hasメソッドは、ディスクにファイルが存在しているかを判定するために使用します。

$exists = Storage::disk('s3')->has('file.jpg');

ファイルのメタ情報

sizeメソッドはファイルのサイズをバイトで取得するために使います。

$size = Storage::size('file1.jpg');

lastModifiedメソッドは最後にファイルが更新された時のUnixタイムスタンプを返します。

$time = Storage::lastModified('file1.jpg');

ファイル保存

putメソッドはディスクのファイルに保存するために使用します。putメソッドにはPHPのresourceも渡すことができ、Flysystemの裏で動いているストリームサポートを使用します。大きなファイルを取り扱う場合は、ストリームの使用を強く推奨します。

Storage::put('file.jpg', $contents);

Storage::put('file.jpg', $resource);

copyメソッドは存在しているファイルをディスクの新しい場所へコピーします。

Storage::copy('old/file1.jpg', 'new/file1.jpg');

moveメソッドは存在しているファイルをリネームするか、新しい場所へ移動します。

Storage::move('old/file1.jpg', 'new/file1.jpg');

ファイルの先頭/末尾追加

prependappendメソッドで、ファイルの初めと終わりに内容を簡単に挿入できます。

Storage::prepend('file.log', 'Prepended Text');

Storage::append('file.log', 'Appended Text');

ファイル削除

deleteメソッドはディスクから削除するファイルを単独、もしくは配列で受け付けます。

Storage::delete('file.jpg');

Storage::delete(['file1.jpg', 'file2.jpg']);

ディレクトリー

ディレクトリーの全ファイル取得

filesメソッドは指定したディレクトリーの全ファイルの配列を返します。指定したディレクトリーのサブディレクトリーにある全ファイルのリストも取得したい場合は、allFilesメソッドを使ってください。

$files = Storage::files($directory);

$files = Storage::allFiles($directory);

ディレクトリーの全ディレクトリー取得

directoriesメソッドは指定したディレクトリーの全ディレクトリーの配列を返します。指定したディレクトリー下の全ディレクトリーと、サブディレクトリー下の全ディレクトリーも取得したい場合は、allDirectoriesメソッドを使ってください。

$directories = Storage::directories($directory);

// 再帰的…
$directories = Storage::allDirectories($directory);

ディレクトリー作成

makeDirectoryメソッドは必要なサブディレクトリーを含め、指定したディレクトリーを作成します。

Storage::makeDirectory($directory);

ディレクトリー削除

最後のdeleteDirectoryはディレクトリーと含まれている全ファイルを削除するために使用されます。

Storage::deleteDirectory($directory);

カスタムファイルシステム

LaravelのFlysystem統合には、最初から様々な「ドライバー」が含まれています。しかしFlysystemはこれらのドライバーに限定されず、他の保存領域システムにも適用できます。皆さんのLaravelアプリケーションに適合した保存システムのカスタムドライバーを作成することができます。

たとえばDropboxFilesystemServiceProviderのような、作成するカスタムファイルシステムのためにサービスプロバイダーを用意してください。プロバイダーのbootメソッドの中でStorageファサードのextendメソッドを使い、カスタムドライバーを定義できます。

<?php

namespace App\Providers;

use Storage;
use League\Flysystem\Filesystem;
use Dropbox\Client as DropboxClient;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Dropbox\DropboxAdapter;

class DropboxServiceProvider extends ServiceProvider
{
    /**
     * サービスの初期処理登録後に実行
     *
     * @return void
     */
    public function boot()
    {
        Storage::extend('dropbox', function($app, $config) {
            $client = new DropboxClient(
                $config['accessToken'], $config['clientIdentifier']
            );

            return new Filesystem(new DropboxAdapter($client));
        });
    }

    /**
     * コンテナで結合の登録
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

extendメソッドの最初の引数はドライバーの名前で、2つ目は$app$config変数を受け取るクロージャーです。このリゾルバークロージャーはLeague\Flysystem\Filesystemのインスタンスを返す必要があります。$config変数はconfig/filesystems.phpで定義したディスクの値を含んでいます。

拡張を登録するサービスプロバイダーを作成したら、config/filesystem.php設定ファイルでdropboxドライバーを使用できます。