amphp/parser

A generator parser to make streaming parsers simple.

v1.1.1 2024-03-21 19:16 UTC

Requires

• php: >=7.4

Requires (Dev)

• amphp/php-cs-fixer-config: ^2
• phpunit/phpunit: ^9
• psalm/phar: ^5.4

MIT

• Aaron Piotrowski
• Niklas Keller

• stream
• parser
• async
• non-blocking

README

AMPHP is a collection of event-driven libraries for PHP designed with fibers and concurrency in mind. amphp/parser allows easily building streaming generator parsers.

Installation

This package can be installed as a Composer dependency.

composer require amphp/parser

Requirements

• PHP 7.4+

Usage

PHP's generators are a great way for building incremental parsers.

Example

This simple parser parses a line delimited protocol and prints a message for each line. Instead of printing a message, you could also invoke a data callback.

$parser = new Parser((function () {
    while (true) {
        $line = yield "\r\n";

        if (trim($line) === "") {
            continue;
        }

        print "New item: {$line}" . PHP_EOL;
    }
})());

for ($i = 0; $i < 100; $i++) {
    $parser->push("bar\r");
    $parser->push("\nfoo");
}

Furthere examples can be found in other AMPHP packages which this library to build streaming parsers.

• ChannelParser in amphp/byte-stream
• RespParser in amphp/redis

Yield Behavior

You can either yield a string that's used as delimiter, an integer that's used as length, or null to flush any remaining buffer in the parser (if any) or await the next call to Parser::push().

Versioning

amphp/parser follows the semver semantic versioning specification like all other amphp packages.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

The MIT License (MIT). Please see LICENSE for more information.