PHP のストリームを理解する

Streams は、PHP が提供する強力なツールであり、それをうまく活用すると、PHP の生産性が大幅に向上します。 Streams のパワーを活用することで、アプリケーションを次のレベルに引き上げることができます。

以下は PHP マニュアルの Streams の説明です:

Streams は、ファイル、ネットワーク、データ圧縮、その他の種類のファイルの操作方法を統一するために使用されます。ファイル操作は、これらの種類のファイルにサービスを提供し、関数インターフェイスの共通セットを提供します。つまり、ストリームはストリーミング動作を行うリソース オブジェクトです。言い換えれば、ストリームに対する読み取りと書き込みを線形に行うことができます。また、 fseek() を使用すると、ストリーム内の任意の位置にジャンプできます。

各 Streams オブジェクトにはラッパー クラスがあり、特別なプロトコルやエンコーディングを処理するための関連コードを追加できます。一般的に使用されるパッケージ クラスの一部は PHP に組み込まれており、カスタム パッケージ クラスを作成して登録することもできます。既存のコンテキストとフィルターを使用してラッパー クラスを変更および拡張することもできます。

ストリームの基本

ストリームは :// を通じて参照できます。このうち、 はパッケージング クラスの名前であり、 の内容はパッケージング クラスの構文によって指定されます。

PHP のデフォルトのパッケージング クラスは file:// です。これは、ファイル システムにアクセスするときに実際にはストリームを使用することを意味します。ファイルの内容は、readfile('/path/to/somefile.txt') または readfile('file:///path/to/somefile.txt') の 2 つの方法で読み取ることができます。これらのメソッドは同等です。 。 readfile('http://google.com/') を使用すると、PHP は動作する HTTP ストリーム ラッパー クラスを選択します。

上で述べたように、PHPは多くの組み込みパッケージクラス、プロトコル、フィルターを提供します。 以下に説明する方法に従って、このマシンでサポートされているパッケージング クラスをクエリできます:

<?php
print_r(stream_get_transports());
print_r(stream_get_wrappers());
print_r(stream_get_filters());

私のマシンでの出力結果は次のとおりです:

Array
(
    [0] => tcp
    [1] => udp
    [2] => unix
    [3] => udg
    [4] => ssl
    [5] => sslv3
    [6] => sslv2
    [7] => tls
)
Array
(
    [0] => https
    [1] => ftps
    [2] => compress.zlib
    [3] => compress.bzip2
    [4] => php
    [5] => file
    [6] => glob
    [7] => data
    [8] => http
    [9] => ftp
    [10] => zip
    [11] => phar
)
Array
(
    [0] => zlib.*
    [1] => bzip2.*
    [2] => convert.iconv.*
    [3] => string.rot13
    [4] => string.toupper
    [5] => string.tolower
    [6] => string.strip_tags
    [7] => convert.*
    [8] => consumed
    [9] => dechunk
    [10] => mcrypt.*
    [11] => mdecrypt.*
)

多くの機能が提供されていますが、うまく見えますか?

上記の組み込みストリームに加えて、Amazon S3、MS Excel、Google ストレージ、Dropbox、さらには Twitter 用のサードパーティ ストリームを作成することもできます。

php:// ラッパークラス

PHP には、この言語で I/O ストリームを処理するためのラッパー クラスが組み込まれています。基本的なストリームは php://stdin、php://stdout、および php://stderr です。これらの 3 つのストリームはそれぞれデフォルトの I/O リソースにマップされます。同時に、PHP は php://input も提供します。これを介して、POST リクエストの生の本文に読み取り専用でアクセスできます。 これは、特に POST リクエストにデータ ペイロードを埋め込むリモート サービスを扱う場合に、非常に便利な機能です。

ここで、cURL ツールを使用して簡単なテストを実行します:

curl -d "Hello World" -d "foo=bar&#038;name=John" <a href="http://localhost/dev/streams/php_input.php">http://localhost/dev/streams/php_input.php</a>

PHP スクリプトで print_r($_POST) を使用したテスト結果は次のとおりです:

Array
(
    [foo] => bar
    [name] => John
)

$_POST 配列の最初の項目は使用できないことに注意してください。データにアクセスできるようになります。しかし、readfile('php://input') を使用すると、結果は異なります:

Hello World&foo=bar&name=John

PHP 5.1 では、一時データの読み取りと書き込みのために、php://memory と php://tempstream という 2 つのパッケージ変換クラスが追加されました。 。ラッパー クラスの名前が示すように、このデータは基盤となるシステムのメモリまたは一時ファイルに保存されます。

php://filter は、ストリームにフィルター機能を追加するために使用されるメタパッケージング クラスです。フィルタは、readfile() または file_get_contents()/stream_get_contents() を使用してストリームを開くときに有効になります。以下に例を示します。

<?php
// Write encoded data
file_put_contents("php://filter/write=string.rot13/resource=file:///path/to/somefile.txt","Hello World");
 
// Read data and encode/decode
readfile("php://filter/read=string.toupper|string.rot13/resource=http://www.google.com");

最初の例では、ディスクに保存されたデータをエンコードするためにフィルターが使用されています。2 番目の例では、リモート URL からデータを読み取るために 2 つのカスケード フィルターが使用されています。フィルターを使用すると、アプリケーションに非常に強力な機能をもたらすことができます。

ストリームコンテキスト

コンテキストは、ストリーム関連のパラメータまたはオプションのセットであり、ラッパークラスの動作を変更または強化するために使用します。たとえば、コンテキストを使用して HTTP ラッパーを変更することは、一般的に使用される使用シナリオです。 このようにして、cURL ツールを使用せずにいくつかの単純なネットワーク操作を完了できます。以下に例を示します:

<?php
$opts = array(
  &#39;http&#39;=>array(
    &#39;method&#39;=>"POST",
    &#39;header&#39;=> "Auth: SecretAuthTokenrn" .
        "Content-type: application/x-www-form-urlencodedrn" .
              "Content-length: " . strlen("Hello World"),
    &#39;content&#39; => &#39;Hello World&#39;
  )
);
$default = stream_context_get_default($opts);
readfile(&#39;http://localhost/dev/streams/php_input.php&#39;);

首先要定义一个options array,这是个二位数组，可以通过$array['wrapper']['option_name']的形式来访问其中的参数。（注意每个包装类中context的options是不同的）。然后调用stream_context_get_default()来设置这些option,stream_context_get_default()同时还会将默认的context作为结果返回回来。设置完成后，接下来调用readfile()，就会应用刚才设置好的context来抓取内容。

　　在上面的例子中，内容被嵌入到request的body中，这样远端的脚本就可以使用php://input来读取这些内容。同时，我们还能使用apache_request_headers()来获取request的header，如下所示：

Array
(
    [Host] => localhost
    [Auth] => SecretAuthToken
    [Content-type] => application/x-www-form-urlencoded
    [Content-length] => 11
)

在上面的例子中是修改默认context的参数，当然我们也可以创建一个新的context,进行交替使用。

<?php
$alternative = stream_context_create($other_opts);
readfile(&#39;http://localhost/dev/streams/php_input.php&#39;, false, $alternative);

　结论

　　我们怎样在现实世界中驾驭stream的强大力量呢？使用stream能为我们的程序带来什么现实的好处？ 正如前文介绍的那样，stream对所有文件系统相关的功能进行了抽象，所以我第一个想到的应用场景是使用虚拟文件系统的包装类来访问PaaS供应商提供的服务，比如说访问HeroKu或者AppFog，它们实际上都没有真正文件系统。 使用stream只要对我们的应用程序稍作修改，就可以将其移植到云端。 接下来--在我的下一篇文章中--我将介绍如何编写自定义的包装类以实现对特殊文件格式和编码格式的操作。