README

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

流实现

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

AppendStream

GuzzleHttp\Psr7\AppendStream

从多个流中按顺序读取。

use GuzzleHttp\Psr7;

$a = Psr7\stream_for('abc, ');
$b = Psr7\stream_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);

$dropping->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过滤器膨胀deflate或gzip内容。

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

LazyOpenStream

GuzzleHttp\Psr7\LazyOpenStream

在流上执行IO操作后才懒洋洋地读取或写入文件。

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的multipart上传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

当读取时返回流式多部分或multipart/form-data流的字节的流。

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的方法。只需使用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)

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

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

`函数 mimetype_from_filename`

函数 mimetype_from_filename($filename)

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

`函数 mimetype_from_extension`

函数 mimetype_from_extension($extension)

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

附加 URI 方法

除了 GuzzleHttp\Psr7\Uri 类中的标准 Psr\Http\Message\UriInterface 实现，此库在处理 URI 时还提供了额外的功能，作为静态方法。

URI 类型

Psr\Http\Message\UriInterface 的实例可以是绝对 URI 或相对引用。绝对 URI 有一个方案。相对引用用于表示相对于另一个 URI（基础 URI）的 URI。相对引用可以根据 RFC 3986 第 4.2 节分为几种形式。

网络路径引用，例如 //example.com/path
绝对路径引用，例如 /path
相对路径引用，例如 subpath

以下方法可以用于识别 URI 的类型。

`GuzzleHttp\Psr7\Uri::isAbsolute`

public static function isAbsolute(UriInterface $uri): bool

URI 是否为绝对，即它有一个方案。

`GuzzleHttp\Psr7\Uri::isNetworkPathReference`

public static function isNetworkPathReference(UriInterface $uri): bool

URI 是否为网络路径引用。以两个斜杠字符开始的相对引用称为网络路径引用。

`GuzzleHttp\Psr7\Uri::isAbsolutePathReference`

public static function isAbsolutePathReference(UriInterface $uri): bool

URI 是否为绝对路径引用。以单个斜杠字符开始的相对引用称为绝对路径引用。

`GuzzleHttp\Psr7\Uri::isRelativePathReference`

public static function isRelativePathReference(UriInterface $uri): bool

判断URI是否为相对路径引用。不以斜杠字符开始的相对引用被称为相对路径引用。

`GuzzleHttp\Psr7\Uri::isSameDocumentReference`

public static function isSameDocumentReference(UriInterface $uri, UriInterface $base = null): bool

判断URI是否为同一文档引用。同一文档引用指的是除了其片段组件外，与基本URI相同的URI。如果没有提供基本URI，则只考虑除片段外的空URI引用为同一文档引用。

URI组件

用于处理URI组件的附加方法。

`GuzzleHttp\Psr7\Uri::isDefaultPort`

public static function isDefaultPort(UriInterface $uri): bool

判断URI是否具有当前方案的默认端口。Psr\Http\Message\UriInterface::getPort可能返回null或标准端口。此方法可以独立于实现使用。

`GuzzleHttp\Psr7\Uri::composeComponents`

public static function composeComponents($scheme, $authority, $path, $query, $fragment): string

根据RFC 3986 第5.3节，从URI的各种组件中组合URI引用字符串。通常，此方法不需要手动调用，而是通过Psr\Http\Message\UriInterface::__toString间接使用。

`GuzzleHttp\Psr7\Uri::fromParts`

public static function fromParts(array $parts): UriInterface

从parse_url组件的哈希中创建URI。

`GuzzleHttp\Psr7\Uri::withQueryValue`

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

创建一个新的URI，具有特定的查询字符串值。与提供的键完全匹配的任何现有查询字符串值都将被删除并替换为给定的键值对。null值将设置不带值的查询字符串键，例如“key”而不是“key=value”。

`GuzzleHttp\Psr7\Uri::withQueryValues`

public static function withQueryValues(UriInterface $uri, array $keyValueArray): UriInterface

创建一个新的URI，具有多个查询字符串值。它具有与withQueryValue()相同的行为，但用于键值对的关联数组。

`GuzzleHttp\Psr7\Uri::withoutQueryValue`

public static function withoutQueryValue(UriInterface $uri, $key): UriInterface

创建一个新的URI，从其中删除特定的查询字符串值。与提供的键完全匹配的任何现有查询字符串值都将被删除。

引用解析

GuzzleHttp\Psr7\UriResolver提供了根据RFC 3986 第5节在基本URI上下文中解析URI引用的方法。例如，当基于当前请求URI解析网站中的链接时，Web浏览器也会这样做。

`GuzzleHttp\Psr7\UriResolver::resolve`

public static function resolve(UriInterface $base, UriInterface $rel): UriInterface

将相对URI转换为与基本URI解析的新URI。

`GuzzleHttp\Psr7\UriResolver::removeDotSegments`

public static function removeDotSegments(string $path): string

根据RFC 3986 第5.2.4节，从路径中删除点段并返回新的路径。

`GuzzleHttp\Psr7\UriResolver::relativize`

public static function relativize(UriInterface $base, UriInterface $target): UriInterface

从基本URI返回目标URI的相对引用。此方法是resolve()方法的对应方法。

(string) $target === (string) UriResolver::resolve($base, UriResolver::relativize($base, $target))

一个用例是使用当前请求URI作为基本URI，然后在文档中生成相对链接以减小文档大小或提供自包含的下载文档存档。

$base = new Uri('http://example.com/a/b/');
echo UriResolver::relativize($base, new Uri('http://example.com/a/b/c'));  // prints 'c'.
echo UriResolver::relativize($base, new Uri('http://example.com/a/x/y'));  // prints '../x/y'.
echo UriResolver::relativize($base, new Uri('http://example.com/a/b/?q')); // prints '?q'.
echo UriResolver::relativize($base, new Uri('http://example.org/a/b/'));   // prints '//example.org/a/b/'.

规范化与比较

GuzzleHttp\Psr7\UriNormalizer 提供了根据 RFC 3986 第6节标准规范和比较 URI 的方法。

`GuzzleHttp\Psr7\UriNormalizer::normalize`

public static function normalize(UriInterface $uri, $flags = self::PRESERVING_NORMALIZATIONS): UriInterface

返回一个规范化后的 URI。方案和主机部分已经按照 PSR-7 UriInterface 规范转换为小写。此方法通过 $flags 参数添加额外的规范化，该参数是一个应用规范的位掩码。以下是一些可用的规范化选项

UriNormalizer::PRESERVING_NORMALIZATIONS

默认的规范化，仅包括保留语义的规范。
UriNormalizer::CAPITALIZE_PERCENT_ENCODING

百分编码三元组中的所有字母（例如，“%3A”）不区分大小写，应该大写。

示例：http://example.org/a%c2%b1b → http://example.org/a%C2%B1b
UriNormalizer::DECODE_UNRESERVED_CHARACTERS

解码未保留字符的百分编码八进制数。为了保持一致性，在 URI 生产者中不应创建范围在 ALPHA (%41–%5A 和 %61–%7A)、DIGIT (%30–%39)、连字符 (%2D)、点 (%2E)、下划线 (%5F) 或波浪号 (%7E) 的百分编码八进制数，当它们出现在 URI 中时，URI 规范化器应将它们解码为相应的未保留字符。

示例：http://example.org/%7Eusern%61me/ → http://example.org/~username/
UriNormalizer::CONVERT_EMPTY_PATH

对于 http 和 https URI，将空路径转换为 "/"。

示例：http://example.org → http://example.org/
UriNormalizer::REMOVE_DEFAULT_HOST

从 URI 中移除给定 URI 方案的默认主机。只有 "file" 方案定义默认主机 "localhost"。所有 file:/myfile、file:///myfile 和 file://localhost/myfile 都根据 RFC 3986 等效。

示例：file://localhost/myfile → file:///myfile
UriNormalizer::REMOVE_DEFAULT_PORT

从 URI 中移除给定 URI 方案的默认端口号。

示例：http://example.org:80/ → http://example.org/
UriNormalizer::REMOVE_DOT_SEGMENTS

删除不必要的点段。在相对路径引用中的点段不会被删除，因为这会改变 URI 引用的语义。

示例：http://example.org/../a/b/../c/./d.html → http://example.org/a/c/d.html
UriNormalizer::REMOVE_DUPLICATE_SLASHES

包含两个或更多相邻斜杠的路径将被转换为一个。Web 服务器通常忽略重复的斜杠，并将这些 URI 视为等效。但在理论上，这些 URI 不一定等效。因此，这种规范化可能会改变语义。编码的斜杠（%2F）不会被删除。

示例：http://example.org//foo///bar.html → http://example.org/foo/bar.html
UriNormalizer::SORT_QUERY_PARAMETERS

按字母顺序对查询参数及其值进行排序。然而，URI 中参数的顺序可能很重要（这不由标准定义）。因此，这种规范化是不安全的，可能会改变 URI 的语义。

示例：?lang=en&article=fred → ?article=fred&lang=en

`GuzzleHttp\Psr7\UriNormalizer::isEquivalent`

public static function isEquivalent(UriInterface $uri1, UriInterface $uri2, $normalizations = self::PRESERVING_NORMALIZATIONS): bool

判断两个 URI 是否可以被认为是等效的。在比较之前，两个 URI 会根据提供的 $normalizations 位掩码自动进行规范化。此方法还接受相对 URI 引用，并在它们等效时返回 true。这当然假设它们将与相同的基 URI 解析。如果不是这种情况，相对引用的等价性或差异的判断没有任何意义。

larvatatw / 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