README

此存储库包含一个 PSR-7 消息实现，几个流装饰器以及一些有用的功能，如查询字符串解析。

流实现

此包包含多个流实现和流装饰器。

AppendStream

GuzzleHttp\Psr7\AppendStream

从多个流中逐个读取。

use GuzzleHttp\Psr7;

$a = Psr7\steam_for('abc, ');
$b = Psr7\steam_for('123.');
$composed = new Psr7\AppendStream([$a, $b]);

$composed->addStream(Psr7\stream_for(' Above all listen to me').

echo $composed(); // abc, 123. Above all listen to me.

BufferStream

GuzzleHttp\Psr7\BufferStream

提供可写入以填充缓冲区并从缓冲区中读取字节的缓冲流。

此流返回一个 "hwm" 元数据值，告诉上游消费者流的配置高水位标志是多少，或者缓冲区的最大首选大小。

use GuzzleHttp\Psr7;

// When more than 1024 bytes are in the buffer, it will begin returning
// false to writes. This is an indication that writers should slow down.
$buffer = new Psr7\BufferStream(1024);

CachingStream

CachingStream 用于在非可寻址流上允许对之前读取的字节进行寻址。这在需要回滚流（例如，由于重定向）以传输非可寻址实体体失败时非常有用。从远程流读取的数据将被缓存在 PHP 临时流中，以便先前读取的字节首先在内存中缓存，然后在磁盘上。

use GuzzleHttp\Psr7;

$original = Psr7\stream_for(fopen('http://www.google.com', 'r'));
$stream = new Psr7\CachingStream($original);

$stream->read(1024);
echo $stream->tell();
// 1024

$stream->seek(0);
echo $stream->tell();
// 0

DroppingStream

GuzzleHttp\Psr7\DroppingStream

当底层流的大小变得过大时开始丢弃数据的流装饰器。

use GuzzleHttp\Psr7;

// Create an empty stream
$stream = Psr7\stream_for();

// Start dropping data when the stream has more than 10 bytes
$dropping = new Psr7\DroppingStream($stream, 10);

$stream->write('01234567890123456789');
echo $stream; // 0123456789

FnStream

GuzzleHttp\Psr7\FnStream

根据函数的散列组合流实现。

允许在不需要为简单的扩展点创建具体类的情况下轻松测试和扩展提供的流。

use GuzzleHttp\Psr7;

$stream = Psr7\stream_for('hi');
$fnStream = Psr7\FnStream::decorate($stream, [
    'rewind' => function () use ($stream) {
        echo 'About to rewind - ';
        $stream->rewind();
        echo 'rewound!';
    }
]);

$fnStream->rewind();
// Outputs: About to rewind - rewound!

InflateStream

GuzzleHttp\Psr7\InflateStream

使用 PHP 的 zlib.inflate 过滤器膨胀 deflated 或 gzipped 内容。

此流装饰器跳过给定流的第一个 10 个字节以移除 gzip 头部，将提供的流转换为 PHP 流资源，然后附加 zlib.inflate 过滤器。然后将流转换回 Guzzle 流资源，用作 Guzzle 流。

LazyOpenStream

GuzzleHttp\Psr7\LazyOpenStream

在流上发生 I/O 操作后，才懒加载地读取或写入文件。

use GuzzleHttp\Psr7;

$stream = new Psr7\LazyOpenStream('/path/to/file', 'r');
// The file has not yet been opened...

echo $stream->read(10);
// The file is opened and read from only when needed.

LimitStream

GuzzleHttp\Psr7\LimitStream

LimitStream 可用于读取现有流对象的一部分或切片。这可以将大文件拆分为更小的部分，以便分块发送（例如，Amazon S3 的多部分上传 API）。

use GuzzleHttp\Psr7;

$original = Psr7\stream_for(fopen('/tmp/test.txt', 'r+'));
echo $original->getSize();
// >>> 1048576

// Limit the size of the body to 1024 bytes and start reading from byte 2048
$stream = new Psr7\LimitStream($original, 1024, 2048);
echo $stream->getSize();
// >>> 1024
echo $stream->tell();
// >>> 0

MultipartStream

GuzzleHttp\Psr7\MultipartStream

当读取时返回流式多部分或多部分/表单数据流的字节的流。

NoSeekStream

GuzzleHttp\Psr7\NoSeekStream

NoSeekStream 包装了一个流，不允许寻址。

use GuzzleHttp\Psr7;

$original = Psr7\stream_for('foo');
$noSeek = new Psr7\NoSeekStream($original);

echo $noSeek->read(3);
// foo
var_export($noSeek->isSeekable());
// false
$noSeek->seek(0);
var_export($noSeek->read(3));
// NULL

PumpStream

GuzzleHttp\Psr7\PumpStream

提供只读流，从 PHP 可调用对象中泵送数据。

当调用提供的可调用对象时，PumpStream 将请求读取的数据量传递给可调用对象。可调用对象可以选择忽略此值并返回少于或多于请求的字节数。任何由提供的可调用对象返回的额外数据都将被内部缓冲，直到使用 PumpStream 的 read() 函数排空。提供的可调用对象必须在没有更多数据可读取时返回 false。

实现流装饰器

创建流装饰器非常简单，多亏了 GuzzleHttp\Psr7\StreamDecoratorTrait。此特性提供了通过代理到底层流来实现 Psr\Http\Message\StreamInterface 方法的函数。只需使用 use StreamDecoratorTrait 并实现您的自定义方法。

例如，假设我们想要在从流中读取最后一个字节时调用一个特定函数。这可以通过重写 read() 方法来实现。

use Psr\Http\Message\StreamInterface;
use GuzzleHttp\Psr7\StreamDecoratorTrait;

class EofCallbackStream implements StreamInterface
{
    use StreamDecoratorTrait;

    private $callback;

    public function __construct(StreamInterface $stream, callable $cb)
    {
        $this->stream = $stream;
        $this->callback = $cb;
    }

    public function read($length)
    {
        $result = $this->stream->read($length);

        // Invoke the callback when EOF is hit.
        if ($this->eof()) {
            call_user_func($this->callback);
        }

        return $result;
    }
}

此装饰器可以添加到任何现有的流中，并按如下方式使用：

use GuzzleHttp\Psr7;

$original = Psr7\stream_for('foo');

$eofStream = new EofCallbackStream($original, function () {
    echo 'EOF!';
});

$eofStream->read(2);
$eofStream->read(1);
// echoes "EOF!"
$eofStream->seek(0);
$eofStream->read(3);
// echoes "EOF!"

PHP StreamWrapper

如果您需要将PSR-7流用作PHP流资源，可以使用GuzzleHttp\Psr7\StreamWrapper类。

使用GuzzleHttp\Psr7\StreamWrapper::getResource()方法从PSR-7流创建PHP流。

use GuzzleHttp\Psr7\StreamWrapper;

$stream = GuzzleHttp\Psr7\stream_for('hello!');
$resource = StreamWrapper::getResource($stream);
echo fread($resource, 6); // outputs hello!

函数API

GuzzleHttp\Psr7命名空间下提供了各种函数。

`函数str`

函数str(MessageInterface $message)

返回HTTP消息的字符串表示。

$request = new GuzzleHttp\Psr7\Request('GET', 'http://example.com');
echo GuzzleHttp\Psr7\str($request);

`函数uri_for`

函数uri_for($uri)

此函数接受一个字符串或Psr\Http\Message\UriInterface，并返回给定值的UriInterface。如果值已经是UriInterface，则原样返回。

$uri = GuzzleHttp\Psr7\uri_for('http://example.com');
assert($uri === GuzzleHttp\Psr7\uri_for($uri));

`函数stream_for`

函数stream_for($resource = '', array $options = [])

根据输入类型创建一个新的流。

选项是一个关联数组，可以包含以下键：

- metadata: 自定义元数据的数组。
- size: 流的大小。

此方法接受以下$resource类型：

Psr\Http\Message\StreamInterface: 原样返回值。
string: 创建一个使用给定字符串作为内容的流对象。
resource: 创建一个包装给定PHP流资源的流对象。
Iterator: 如果提供的值实现了Iterator，则创建一个包装给定可迭代的只读流对象。每次从流中读取时，迭代器中的数据将填充缓冲区，并持续调用，直到缓冲区等于请求的读取大小。后续的读取调用将首先从缓冲区中读取，然后在对底层迭代器调用next，直到迭代器耗尽。
object with __toString(): 如果对象具有__toString()方法，则对象将转换为字符串，然后返回一个使用字符串值的流。
NULL: 当传入null时，返回一个空流对象。
callable 当传入可调用时，创建一个调用给定可调用的只读流对象。可调用以建议读取的字节数调用。可调用可以返回任意数量的字节数，但必须在没有更多数据返回时返回false。包装可调用的流对象将调用可调用，直到请求的字节数可用。任何额外的字节数都将被缓冲并用于后续的读取。

$stream = GuzzleHttp\Psr7\stream_for('foo');
$stream = GuzzleHttp\Psr7\stream_for(fopen('/path/to/file', 'r'));

$generator function ($bytes) {
    for ($i = 0; $i < $bytes; $i++) {
        yield ' ';
    }
}

$stream = GuzzleHttp\Psr7\stream_for($generator(100));

`函数parse_header`

函数parse_header($header)

将包含";"分隔数据的数组解析成表示头键值对数据的关联数组数组。当一个参数不包含值，只包含键时，此函数将向键注入一个值为''的字符串。

`函数normalize_header`

函数normalize_header($header)

将可能包含逗号分隔头的头值数组转换为不包含逗号分隔值的头数组。

`函数modify_request`

函数modify_request(RequestInterface $request, array $changes)

克隆并修改具有给定更改的请求。此方法对于减少修改消息所需克隆的数量非常有用。

更改可以是以下之一：

method: (string) 改变HTTP方法。
set_headers: (array) 设置给定头。
remove_headers: (array) 移除给定头。
body: (mixed) 设置给定体。
uri: (UriInterface) 设置URI。
query: (string) 设置URI的查询字符串值。
version: (string) 设置协议版本。

`函数rewind_body`

函数rewind_body(MessageInterface $message)

尝试回滚消息体，并在失败时抛出异常。只有当调用 tell() 返回值不是 0 时，消息体才会被回滚。

`函数 try_fopen`

函数 try_fopen($filename, $mode)

使用文件名安全地打开 PHP 流资源。

当 fopen 失败时，PHP 通常会抛出警告。此函数添加了一个错误处理程序，它会检查错误并抛出异常。

`函数 copy_to_string`

函数 copy_to_string(StreamInterface $stream, $maxLen = -1)

将流的内容复制到字符串中，直到读取到指定数量的字节。

`函数 copy_to_stream`

函数 copy_to_stream(StreamInterface $source, StreamInterface $dest, $maxLen = -1)

将流的内容复制到另一个流中，直到读取到指定数量的字节。

`函数 hash`

函数 hash(StreamInterface $stream, $algo, $rawOutput = false)

计算流的哈希值。此方法读取整个流以计算滚动哈希（基于 PHP 的 hash_init 函数）。

`函数 readline`

函数 readline(StreamInterface $stream, $maxLength = null)

从流中读取一行，直到达到最大允许的缓冲区长度。

`函数 parse_request`

函数 parse_request($message)

将请求消息字符串解析为请求对象。

`函数 parse_response`

函数 parse_response($message)

将响应消息字符串解析为响应对象。

`函数 parse_query`

函数 parse_query($str, $urlEncoding = true)

将查询字符串解析为关联数组。

如果找到相同键的多个值，该键值对的值将变成一个数组。此函数不会将嵌套的 PHP 风格数组解析为关联数组（例如，foo[a]=1&foo[b]=2 将被解析为 ['foo[a]' => '1', 'foo[b]' => '2']）。

`函数 build_query`

函数 build_query(array $params, $encoding = PHP_QUERY_RFC3986)

从键值对数组构建查询字符串。

此函数可以使用 parseQuery() 的返回值构建查询字符串。此函数在遇到数组时不会修改提供的键（如 http_build_query 会做的那样）。

`函数 mimetype_from_filename`

函数 mimetype_from_filename($filename)

通过查看扩展名确定文件的 MIME 类型。

`函数 mimetype_from_extension`

函数 mimetype_from_extension($extension)

将文件扩展名映射到 MIME 类型。

静态 URI 方法

GuzzleHttp\Psr7\Uri 类具有几个静态方法来操作 URI。

`GuzzleHttp\Psr7\Uri::removeDotSegments`

public static function removeDotSegments($path) -> UriInterface

从路径中删除点段并返回新的路径。

参见 http://tools.ietf.org/html/rfc3986#section-5.2.4

`GuzzleHttp\Psr7\Uri::resolve`

public static function resolve(UriInterface $base, $rel) -> UriInterface

解析基本 URI 和相对 URI 并返回一个新的 URI。

参见 http://tools.ietf.org/html/rfc3986#section-5

`GuzzleHttp\Psr7\Uri::withQueryValue`

public static function withQueryValue(UriInterface $uri, $key, $value) -> UriInterface

创建一个新的 URI，并带有特定的查询字符串值。

如果存在与提供的键完全匹配的现有查询字符串值，则将其移除并替换为给定的键值对。

注意：此函数将 "=" 转换为 "%3D" 和 "&" 转换为 "%26"。

`GuzzleHttp\Psr7\Uri::withoutQueryValue`

public static function withoutQueryValue(UriInterface $uri, $key, $value) -> UriInterface

创建一个新的 URI，并移除了特定的查询字符串值。

如果存在与提供的键完全匹配的现有查询字符串值，则将其移除。

注意：此函数将 "=" 转换为 "%3D" 和 "&" 转换为 "%26"。

`GuzzleHttp\Psr7\Uri::fromParts`

public static function fromParts(array $parts) -> UriInterface

从一个 parse_url 部分的哈希中创建一个 GuzzleHttp\Psr7\Uri 对象。

未实现

本项目中未实现 PSR-7 的某些方面。欢迎对这些功能中的任何一个提出拉取请求。

PSR\Http\Message\ServerRequestInterface
PSR\Http\Message\UploadedFileInterface

luongtran / psr7

维护者

详情

README

流实现

AppendStream

BufferStream

CachingStream

DroppingStream

FnStream

InflateStream

LazyOpenStream

LimitStream

MultipartStream

NoSeekStream

PumpStream

实现流装饰器

PHP StreamWrapper

函数API

函数str

函数uri_for

函数stream_for

函数parse_header

函数normalize_header

函数modify_request

函数rewind_body

函数 try_fopen

函数 copy_to_string

函数 copy_to_stream

函数 hash

函数 readline

函数 parse_request

函数 parse_response

函数 parse_query

函数 build_query

函数 mimetype_from_filename

函数 mimetype_from_extension