From 11adadd815a0160df2ce106d77bae194e22d24bf Mon Sep 17 00:00:00 2001 From: Yada Clintjens Date: Fri, 9 Feb 2024 07:35:09 +0100 Subject: [PATCH] Improve documentation and examples --- README.md | 6 +++++- examples/random-colors.php | 10 +++------- examples/remove-codes.php | 10 +++------- examples/stdin-codes.php | 7 ++----- 4 files changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 1ef2367..a66ec97 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,13 @@ It wraps a given `ReadableStreamInterface` and exposes its plain data through the same interface. ```php +on('data', function ($chunk) { var_dump($chunk); diff --git a/examples/random-colors.php b/examples/random-colors.php index 68beb26..d6d4c89 100644 --- a/examples/random-colors.php +++ b/examples/random-colors.php @@ -11,10 +11,6 @@ // with random colors: // $ phpunit --color=always | php random-colors.php -use Clue\React\Term\ControlCodeParser; -use React\Stream\ReadableResourceStream; -use React\Stream\WritableResourceStream; - require __DIR__ . '/../vendor/autoload.php'; if (function_exists('posix_isatty') && posix_isatty(STDIN)) { @@ -23,10 +19,10 @@ } // process control codes from STDIN -$stdin = new ReadableResourceStream(STDIN); -$parser = new ControlCodeParser($stdin); +$stdin = new React\Stream\ReadableResourceStream(STDIN); +$parser = new Clue\React\Term\ControlCodeParser($stdin); -$stdout = new WritableResourceStream(STDOUT); +$stdout = new React\Stream\WritableResourceStream(STDOUT); // pass all c0 codes through to output $parser->on('c0', array($stdout, 'write')); diff --git a/examples/remove-codes.php b/examples/remove-codes.php index 5e7db8d..ac1f4c6 100644 --- a/examples/remove-codes.php +++ b/examples/remove-codes.php @@ -8,10 +8,6 @@ // codes like this: // $ phpunit --color=always | php remove-codes.php -use Clue\React\Term\ControlCodeParser; -use React\Stream\ReadableResourceStream; -use React\Stream\WritableResourceStream; - require __DIR__ . '/../vendor/autoload.php'; if (function_exists('posix_isatty') && posix_isatty(STDIN)) { @@ -20,11 +16,11 @@ } // process control codes from STDIN -$stdin = new ReadableResourceStream(STDIN); -$parser = new ControlCodeParser($stdin); +$stdin = new React\Stream\ReadableResourceStream(STDIN); +$parser = new Clue\React\Term\ControlCodeParser($stdin); // pipe data from STDIN to STDOUT without any codes -$stdout = new WritableResourceStream(STDOUT); +$stdout = new React\Stream\WritableResourceStream(STDOUT); $parser->pipe($stdout); // only forward \r, \n and \t diff --git a/examples/stdin-codes.php b/examples/stdin-codes.php index 8845dbb..2a35b6e 100644 --- a/examples/stdin-codes.php +++ b/examples/stdin-codes.php @@ -9,9 +9,6 @@ // codes like this: // $ phpunit --color=always | php stdin-codes.php -use Clue\React\Term\ControlCodeParser; -use React\Stream\ReadableResourceStream; - require __DIR__ . '/../vendor/autoload.php'; if (function_exists('posix_isatty') && posix_isatty(STDIN)) { @@ -20,8 +17,8 @@ } // process control codes from STDIN -$stdin = new ReadableResourceStream(STDIN); -$parser = new ControlCodeParser($stdin); +$stdin = new React\Stream\ReadableResourceStream(STDIN); +$parser = new Clue\React\Term\ControlCodeParser($stdin); $decoder = function ($code) { echo 'Code:';