Laravel Storage の put() と putFileAs() の違いがわからない。

Question

初歩的な質問ですみません。

LaravelのStorageのメソッドで、put() と putFileAs() の違いがよくわかりません。

公式ドキュメントの日本語訳（https://readouble.com/laravel/6.x/ja/filesystem.html）を見てみると、purFileAs()では自動ストリーミングを管理してくれると書いてあるのですが、よく意味がわからなくて...。

ストリーミングとは、YouTubeのように、少しずつデータをダウンロードしつつ、同時並行で動画を流すことだと思っているのですが、putFileAs()でも同じように、少しずつ画像をアップロードしてくれるということなのでしょうか？

その場合、画像をサーバにアップロードする点に関して、put()と比較してどのようなメリットがあるのでしょうか？

教えて頂けると嬉しいです。
よろしくお願いいたします。

Comments

[m.ts10806]

>公式ドキュメントを見てみると、

公式と言うとlaravel.comからのDocumentationですが、そちらで間違いないですか？齟齬があってはいけませんので、URLをリンクで提示してください。

[takaoS]

情報が足りなかったですね、申し訳ありません。
こちら↓になります。
https://readouble.com/laravel/6.x/ja/filesystem.html

[m.ts10806]

質問は編集できますので追記してください

[m.ts10806]

ちなみにreadoubleは「公式ドキュメント」ではないです。
「公式を日本語訳したドキュメント」です。公式に近しいものであって公式はあくまで先に提示したlaravel.comです。

[takaoS]

そうなんですね、申し訳ないです。

[m.ts10806]

私もteratailの回答で指摘されて認識したことなので、謝ることはないと思います。
ただ、原文を結構正確に訳しているので、大きな問題はないと思ってます。

Answer 1

この場合の「ストリーミング」というのは「書き込みたい内容をPHPの変数として一度にメモリ上に用意しなくていい」ぐらいの意味です。

そしてストリームサポートはマニュアルの少し手前のところに書かれているようにputにもあります。

putメソッドはファイル内容をディスクへ保存するために使用します。putメソッドにはPHPのresourceも渡すことができ、Flysystemの裏で動いているストリームサポートを使用します。

まずストリーミングでない場合はどういうものか説明します。putの$contentsパラメタに送りたいファイルの中身を設定するのが基本の使い方で、例えば画像ファイルならいったんfile_get_contentsを使って全体を変数に読み込んでからputします。一度に全部メモリ上に読み込むのでメモリを食います。

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

ストリーミングの場合はどうなるかというと、ファイルを開いただけで中身は読み込まずにそのままリソースをパラメタとして渡します。こちらの場合は一度に中身を読み込まずに一定量ずつ読んでは書くようなことを裏で行ってくれるのでメモリの消費が抑えられます。

$resource = fopen('foo.jpg', 'r');
Storage::put('file.jpg', $resource);
fclose($resource);

そしてputFileAsはパラメタで与えたファイル名からfopenしてputしてfcloseという一連の流れを「自動」でやってくれます。実際ソースはこうなっています。これを「自動ストリーミング」と呼んでいるようです。

    /**
     * Store the uploaded file on the disk with a given name.
     *
     * @param  string  $path
     * @param  \Illuminate\Http\File|\Illuminate\Http\UploadedFile|string  $file
     * @param  string  $name
     * @param  array  $options
     * @return string|false
     */
    public function putFileAs($path, $file, $name, $options = [])
    {
        $stream = fopen(is_string($file) ? $file : $file->getRealPath(), 'r');

        // Next, we will format the path of the file and store the file using a stream since
        // they provide better performance than alternatives. Once we write the file this
        // stream will get closed automatically by us so the developer doesn't have to.
        $result = $this->put(
            $path = trim($path.'/'.$name, '/'), $stream, $options
        );

        if (is_resource($stream)) {
            fclose($stream);
        }

        return $result ? $path : false;
    }

Comments

[takaoS]

なるほど、そういうことだったのですね。
ご丁寧に解説いただきありがとうございました！