README

此存储库包含部分 PSR-7 消息实现，几个流装饰器以及一些有用的功能，如查询字符串解析。目前缺少 ServerRequestInterface 和 UploadedFileInterface；欢迎对这些功能的拉取请求。

此项目是从以下地址分支而来：https://github.com/guzzle/psr7

流实现

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

AppendStream

Chinook\Psr7\AppendStream

从多个流中按顺序读取。

use Chinook\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

Chinook\Psr7\BufferStream

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

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

use Chinook\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 Chinook\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

Chinook\Psr7\DroppingStream

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

use Chinook\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

Chinook\Psr7\FnStream

基于函数散列的流实现。

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

use Chinook\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

Chinook\Psr7\InflateStream

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

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

LazyOpenStream

Chinook\Psr7\LazyOpenStream

在流上发生 IO 操作之后，延迟读取或写入文件。

use Chinook\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

Chinook\Psr7\LimitStream

LimitStream 可用于读取现有流对象的子集或切片。这对于将大文件分成小块以分块发送非常有用（例如，Amazon S3 的分片上传 API）。

use Chinook\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

Chinook\Psr7\MultipartStream

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

NoSeekStream

Chinook\Psr7\NoSeekStream

NoSeekStream 包装流并不允许寻址。

use Chinook\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

Chinook\Psr7\PumpStream

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

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

实现流装饰器

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

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

use Psr\Http\Message\StreamInterface;
use Chinook\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 Chinook\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 流资源，可以使用 Chinook\Psr7\StreamWrapper 类。

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

use Chinook\Psr7\StreamWrapper;

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

函数 API

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

`函数 str`

function str(MessageInterface $message)

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

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

`函数 uri_for`

function uri_for($uri)

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

$uri = Chinook\Psr7\uri_for('http://example.com');
assert($uri === Chinook\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 = Chinook\Psr7\stream_for('foo');
$stream = Chinook\Psr7\stream_for(fopen('/path/to/file', 'r'));

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

$stream = Chinook\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)

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

更改可以是以下之一

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

`function rewind_body`

function rewind_body(MessageInterface $message)

尝试回滚消息正文，如果失败则抛出异常。只有当调用tell()返回值不为0时，消息的正文才会被回滚。

`function try_fopen`

function try_fopen($filename, $mode)

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

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

`function copy_to_string`

function copy_to_string(StreamInterface $stream, $maxLen = -1)

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

`function copy_to_stream`

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

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

`function hash`

function hash(StreamInterface $stream, $algo, $rawOutput = false)

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

`function readline`

function readline(StreamInterface $stream, $maxLength = null)

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

`function parse_request`

function parse_request($message)

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

`function parse_response`

function parse_response($message)

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

`function parse_query`

function parse_query($str, $urlEncoding = true)

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

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

`function build_query`

function build_query(array $params, $encoding = PHP_QUERY_RFC3986)

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

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

`function mimetype_from_filename`

function mimetype_from_filename($filename)

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

`function mimetype_from_extension`

function mimetype_from_extension($extension)

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

静态URI方法

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

`Chinook\Psr7\Uri::removeDotSegments`

public static function removeDotSegments($path) -> UriInterface

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

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

`Chinook\Psr7\Uri::resolve`

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

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

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

`Chinook\Psr7\Uri::withQueryValue`

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

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

删除与提供的键完全匹配的现有查询字符串值，并用给定的键值对替换。

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

`Chinook\Psr7\Uri::withoutQueryValue`

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

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

删除与提供的键完全匹配的现有查询字符串值。

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

`Chinook\Psr7\Uri::fromParts`

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

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

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

function rewind_body

function try_fopen

function copy_to_string

function copy_to_stream

function hash

function readline

function parse_request

function parse_response

function parse_query

function build_query

function mimetype_from_filename

function mimetype_from_extension