Laravel 5.2 ファイルシステム/クラウドストレージ

イントロダクション

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

設定

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

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

Publicディスク

publicディスクは一般公開へのアクセスを許すファイルを意味しています。デフォルトのpublicディスクは、localドライバを使用しており、storage/app/public下に存在しているファイルです。Webからのアクセスを許すには、public/storageからstorage/app/publicへシンボリックリンクを張る必要があります。この手法により、公開ファイルを一つのディレクトリへ留め、Envoyerのようなリリース時のダウンタイムが起きない開発システムを使っている場合、各リリース間でファイルを簡単に共有できます。

もちろん、ファイルを保存し、シンボリックリンクが張られたら、assetヘルパを使いファイルへのURLを生成できます。

echo asset('storage/file.txt');

ローカルドライバ

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

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

他のドライバ使用要件

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

FTPドライバ設定

Laravelのファイルシステム統合はFTPでも動作します。しかし、デフォルトでは、フレームワークのfilesystems.php設定ファイルに、サンプルの設定を含めていません。FTPファイルシステムを設定する必要がある場合は、以下の設定例を利用してください。

'ftp' => [
    'driver'   => 'ftp',
    'host'     => 'ftp.example.com',
    'username' => 'your-username',
    'password' => 'your-password',

    // 任意のFTP設定
    // 'port'     => 21,
    // 'root'     => '',
    // 'passive'  => true,
    // 'ssl'      => true,
    // 'timeout'  => 30,
],

Rackspaceドライバ設定

Laravelのファイルシステム統合はRackspaceでも動作します。しかし、デフォルトでは、フレームワークのfilesystems.php設定ファイルに、サンプルの設定を含めていません。Rackspaceファイルシステムを設定する必要がある場合は、以下の設定例を利用してください。

'rackspace' => [
    'driver'    => 'rackspace',
    'username'  => 'your-username',
    'key'       => 'your-key',
    'container' => 'your-container',
    'endpoint'  => 'https://identity.api.rackspacecloud.com/v2.0/',
    'region'    => 'IAD',
    'url_type'  => 'publicURL',
],

基本的な使用法

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

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');

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

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

ファイルURL

locals3ドライバを使用するとき、指定したファイルのURLを取得するために、urlメソッドを使ってください。localドライバを使用している場合、このメソッドは通常、指定したパスの先頭に/strorageを付け、そのファイルへの相対パスを返します。s3ドライバを使用している場合、完全なリモートURLを返します。

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

注意: localドライバ使用時、storage/app/publicディレクトリへ、public/storageからのリンクを張るのを忘れないでください。

ファイルのメタ情報

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');

ファイル視認性

ファイル視認性はgetVisibilitysetVisibilityメソッドにより取り扱います。視認性とはマルチプラットフォーム間におけるファイルパーミッションを抽象したものです。

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

Storage::setVisibility('file.jpg', 'public');

さらに、putメソッドによりファイルを設定するとき、視認性を指定することもできます。視認性はpublicprivateです。

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

ファイル削除

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ドライバを使用できます。

ドキュメント章別ページ

ヘッダー項目移動

注目:アイコン:ページ内リンク設置(リンクがないヘッダーへの移動では、リンクがある以前のヘッダーのハッシュをURLへ付加します。

移動

クリックで即時移動します。

バージョン

設定

適用ボタンクリック後に、全項目まとめて適用されます。

カラーテーマ
和文指定 Pagination
和文指定 Scaffold
Largeスクリーン表示幅
インデント
本文フォント
コードフォント
フォント適用確認

フォントの指定フィールドから、フォーカスが外れると、当ブロックの内容に反映されます。EnglishのDisplayもPreviewしてください。

フォント設定時、表示に不具合が出た場合、当サイトのクッキーを削除してください。

バックスラッシュを含むインライン\Code\Blockの例です。

以下はコードブロックの例です。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザに関連する電話レコードを取得
     */
    public function phone()
    {
        return $this->hasOne('App\Phone');
    }
}

設定を保存する前に、表示が乱れないか必ず確認してください。CSSによるフォントファミリー指定の知識がない場合は、フォントを変更しないほうが良いでしょう。

キーボード・ショートカット

オープン操作

PDC

ページ(章)移動の左オフキャンバスオープン

HA

ヘッダー移動モーダルオープン

MS

移動/設定の右オフキャンバスオープン

ヘッダー移動

T

最初のヘッダーへ移動

E

最後のヘッダーへ移動

NJ

次ヘッダー(H2〜H4)へ移動

BK

前ヘッダー(H2〜H4)へ移動

その他

?

このヘルプページ表示
閉じる