keinos/mastodon-streaming-api-parser

Parses the Mastodon Streaming API server-sent events to JSON.

1.0.1 2020-07-24 17:10 UTC

This package is auto-updated.

Last update: 2022-09-24 22:15:50 UTC


README

Server-Sent Events parser of Mastodon Streaming API in PHP

This class simply parses the received lines from server-sent events of the Mastodon Streaming API to JSON object string.

The below lines (server-sent event messages) will be parsed in JSON as below.

5b1
event: update
data: {"id":"10000 ... visible\">0FS8QET2TT</span></a><br><a hr
350
ef=\"https://www ... ts":[],"mentions":[],"tags":[],"emojis":[]}

use \KEINOS\MSTDN_TOOLS\Parser\Parser;

$parser = new Parser();

while (! feof($stream)) {
    $line = fgets($stream);
    $json = $parser->parse($line);
    if (false === $json) {
        continue;
    }
    echo $json . PHP_EOL;
}

{"event":"update","payload":{"id":"10000 ... visible\">0FS8QET2TT<\/span><\/a><br><a href=\"https:\/\/www .... ts":[],"mentions":[],"tags":[],"emojis":[]}}

Use this class if you are receiving the streaming signal directly from Mastodon Streaming API via socket connection, rather than WebSocket which requires an access token when upgrading the protocol.

Install

composer require keinos/mastodon-streaming-api-parser

Usage

  • Instantiation

    $parser = new \KEINOS\MSTDN_TOOLS\Parser\Parser();
  • Method

    /**
     * @param  string $line   Received streaming line.
     * @return bool|string    Returns the data unit in JSON string. Or false if the
     *                        status is "buffering in progress".
     */
    $json = $parser->parse($line);
  • Returned JSON string structure

    {
        "event":"[Event name]",
        "payload":"[Data of the event]"
    }
  • Interface: ParserInterface.php

Sample

// Instantiate the parser
$parser = new \KEINOS\MSTDN_TOOLS\Parser\Parser();
// Open socket
$fp = fsockopen($hostname, $port, $errno, $errstr, $timeout);
// Send GET request
fwrite($fp, $req);
// Looper
while (! feof($fp)) {
    // Read the stream
    $read = fgets($fp);
    // Buffer each line until it returns the data
    $json = $parser->parse($read);
    if (false === $json) {
        continue;
    }
    // Do something with the data
    echo $json . PHP_EOL;
}
// Close connection
fclose($fp);

Specifications/Info

Contribution

  • Issues
    • Throw an issue at: https://github.com/KEINOS/Mastodon_StreamingAPI_Parser/issues
    • If the issue is a bug, then please provide a simple example that are reproducible.
    • If the issue is a feature request, then also provide a simple example with the results you wish, so we can create a test before implementing your feature.
  • PR (Pull Request)
    • Please PR to the padawan branch. After the CI tests/reviews, then merged to master branch it will ;-)
    • For more see: CONTRIBUTE.md
  • Rules
    • Be nice, be happy and stay safe.