chevere/writer

流式写入工具

1.0.2 2024-06-05 21:49 UTC

This package is auto-updated.

Last update: 2024-09-05 22:29:49 UTC


README

🔔 订阅 通讯,不错过Chevere的任何更新。

Chevere

Build Code size Apache-2.0 PHPStan Mutation testing badge

Quality Gate Status Maintainability Rating Reliability Rating Security Rating Coverage Technical Debt CodeFactor

摘要

Writer提供了流式写入的工具。

安装

Writer可通过Packagist获取,源代码仓库位于chevere/writer

composer require chevere/writer

流用途

使用streamFor函数创建流。

use function Chevere\Writer\streamFor;

$stream = streamFor(
    stream: 'php://temp',
    mode: 'r+'
);

临时流

使用streamTemp函数创建临时流(rw+)。

use function Chevere\Writer\streamTemp;

$stream = streamTemp($content);

StreamWriter

使用StreamWriter将字符串写入流。

use Chevere\Writer\StreamWriter;
use function Chevere\Writer\streamFor;

$stream = streamFor('php://output', 'r');
$writer = new StreamWriter($stream);
$writer->write('Hello, world!');

NullWriter

需要null写入覆盖时使用NullWriter

Writers

使用Writers与预定义的输出、错误、调试和日志流进行交互。默认情况下,仅定义了输出和错误流。

use Chevere\Writer\Writers;

$writers = new Writers();
$writers->error();
$writers->debug();
$writers->log();

输出流

使用output与输出流进行交互。使用withOutput设置自定义输出流。

$with = $writers->withOutput($stream);
$with->output(); // $stream

错误流

使用error与错误流进行交互。使用withError设置自定义错误流。

$with = $writers->withError($stream);
$with->error(); // $stream

调试流

使用debug与调试流进行交互。使用withDebug设置自定义调试流。

$with = $writers->withDebug($stream);
$with->debug(); // $stream

日志流

使用log与日志流进行交互。使用withLog设置自定义日志流。

$with = $writers->withLog($stream);
$with->log(); // $stream

文档

文档可在chevere.org找到。

许可证

版权所有 Rodolfo Berrios A.

Chevere采用Apache许可证,版本2.0。完整的许可证文本见LICENSE

除非适用法律要求或书面同意,否则在许可证下分发的软件按“现状”提供,不提供任何明示或暗示的保证或条件。请参阅许可证,了解具体管理许可权限和限制的条款。