イントロダクション

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

設定

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

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

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

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

localドライバーを使用する場合、設定ファイルで定義されている、rootディレクトリーからの相対位置として、全ファイルは操作されます。デフォルトでは、この値はstorage/appディレクトリーになっています。ですから、次のコードはstorage/app/file.txtへファイルを保存します。

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

基本的な使用法

Storageファサードを使い、設定済みのディスクへの操作ができます。サービスコンテナにより依存解決が行われるクラスで、Illuminate\Contracts\Filesystem\Factory契約をタイプヒントで指定することもできます。

特定のディスクの取得

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

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

ファイルの存在チェック

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

デフォルトディスクのメソッド呼び出し

if (Storage::exists('file.jpg'))
{
    //
}

ファイルの内容の取得

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

ファイルへ内容を保存

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

ファイルの先頭に追加

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

ファイルの最後に追加

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

ファイル削除

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

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

ファイルを新しい場所へコピー

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

ファイルを新しい場所へ移動

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

ファイルサイズの取得

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

最後の修正時間の取得(Unix)

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

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

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

// 再帰的…
$files = Storage::allFiles($directory);

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

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

// Recursive...
$directories = Storage::allDirectories($directory);

ディレクトリー作成

Storage::makeDirectory($directory);

ディレクトリー削除

Storage::deleteDirectory($directory);

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

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

例えばDropboxFilesystemServiceProviderのような、作成するカスタムファイルシステムのために、サービスプロバイダーを用意してください。プロバイダーのbootメソッドの中へ、Illuminate\Contracts\Filesystem\Factory契約のインスタンスを注入し、extendメソッドを呼び出します。もしくは、Diskファサードのextendメソッドを使うこともできます。

extendメソッドの最初の引数はドライバーの名前で、2つ目は$app$config変数を受け取るクロージャーです。このリゾルバ−クロージャーは、League\Flysystem\Filesystemのインスタンスを返す必要があります。

注意: $config変数は、config/filesystems.phpの中で定義されている、指定されたディスクの値を含んでいます。

Dropbox準備例

<?php namespace App\Providers;

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

class DropboxFilesystemServiceProvider extends ServiceProvider {

    public function boot()
    {
        Storage::extend('dropbox', function($app, $config)
        {
            $client = new DropboxClient($config['accessToken'], $config['clientIdentifier']);

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

    public function register()
    {
        //
    }

}