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 过滤器来解压 zlib（HTTP deflate，RFC1950）或 gzipped（RFC1952）内容。

此流装饰器将提供的流转换为 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 的多部分上传 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

当读取时返回用于流式传输多部分或多部分/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。只需 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 流包装器

如果您需要将 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`

function str(MessageInterface $message)

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

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

`函数 uri_for`

function 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`

function 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`

function parse_header($header)

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

`函数 normalize_header`

function normalize_header($header)

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

`函数 modify_request`

function modify_request(RequestInterface $request, array $changes)

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

更改可以是以下之一

method: (string) 更改 HTTP 方法。
set_headers: (array) 设置给定的头部。
remove_headers: (array) 删除给定的头部。
body: (混合类型) 设置给定的主体。
uri: (UriInterface) 设置URI。
query: (字符串) 设置URI的查询字符串值。
version: (字符串) 设置协议版本。

`函数 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类型。

`函数 get_message_body_summary`

函数 get_message_body_summary(MessageInterface $message, $truncateAt = 120)

获取消息主体的简短摘要。

如果响应不可打印，则返回null。

额外的URI方法

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

URI类型

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

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

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

`GuuzzleHttp\Psr7\Uri::isAbsolute`

public static function isAbsolute(UriInterface $uri): bool

判断URI是否绝对，即它是否有方案。

`GuuzzleHttp\Psr7\Uri::isNetworkPathReference`

public static function isNetworkPathReference(UriInterface $uri): bool

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

`GuuzzleHttp\Psr7\Uri::isAbsolutePathReference`

public static function isAbsolutePathReference(UriInterface $uri): bool

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

`GuuzzleHttp\Psr7\Uri::isRelativePathReference`

public static function isRelativePathReference(UriInterface $uri): bool

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

`GuuzzleHttp\Psr7\Uri::isSameDocumentReference`

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

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

URI组件

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

`GuuzzleHttp\Psr7\Uri::isDefaultPort`

public static function isDefaultPort(UriInterface $uri): bool

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

`GuuzzleHttp\Psr7\Uri::composeComponents`

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

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

`GuuzzleHttp\Psr7\Uri::fromParts`

public static function fromParts(array $parts): UriInterface

从一个包含parse_url组件的哈希中创建URI。

`GuuzzleHttp\Psr7\Uri::withQueryValue`

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

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

`GuuzzleHttp\Psr7\Uri::withQueryValues`

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

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

`GuuzzleHttp\Psr7\Uri::withoutQueryValue`

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

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

引用解析

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

`GuuzzleHttp\Psr7\UriResolver::resolve`

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

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

`GuuzzleHttp\Psr7\UriResolver::removeDotSegments`

public static function removeDotSegments(string $path): string

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

`GuuzzleHttp\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

解码未保留字符的百分编码八进制字节。为了保持一致，在范围ALPHA（%41–%5A和%61–%7A）、DIGIT（%30–%39）、连字符（%2D）、点（%2E）、下划线（%5F）或波浪号（%7E）中的百分编码八进制字节不应由URI生产者创建，并且当它们在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。如果不是这种情况，相对引用的等价性或差异的确定没有任何意义。

fengyongz-guzzlehttp / psr7

维护者

详细信息

README

流实现

AppendStream

BufferStream

CachingStream

DroppingStream

FnStream

InflateStream

LazyOpenStream

LimitStream

MultipartStream

NoSeekStream

PumpStream

实现流装饰器

PHP 流包装器

函数 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

函数 get_message_body_summary